Skip to content

Commit

Permalink
update readme for v1
Browse files Browse the repository at this point in the history
  • Loading branch information
maxibor committed Feb 25, 2020
1 parent e3fb29d commit f2df91d
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Publish Anaconda Package
A Github Action to publish your Python package to Anaconda repository.

### Example workflow
A Github Action to publish your software package to an Anaconda repository.

### Example workflow to publish to conda every time you make a new release

```yaml
name: publish_conda
Expand All @@ -12,11 +13,33 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- name: publish-to-conda
uses: maxibor/conda-package-publish-action@master
uses: maxibor/conda-package-publish-action@v1
with:
subDir: 'conda'
AnacondaToken: ${{ secrets.ANACONDA_TOKEN }}
```
Get an Anaconda token (with read and write API access) at anaconda.org/username/settings/access and add it to the Secrets of the Github repository as `ANACONDA_TOKEN`
### Example project structure
```
.
├── LICENSE
├── README.md
├── myproject
│   ├── __init__.py
│   └── myproject.py
├── conda
│   ├── build.sh

This comment has been minimized.

Copy link
@fcakyon

fcakyon Apr 5, 2020

can you post an example build.sh file, what should it look like?

│   └── meta.yaml
├── .github
│   └── workflows
│   └── publish_conda.yml
├── .gitignore
```

### ANACONDA_TOKEN

1. Get an Anaconda token (with read and write API access) at `anaconda.org/USERNAME/settings/access`
2. Add it to the Secrets of the Github repository as `ANACONDA_TOKEN`

0 comments on commit f2df91d

Please sign in to comment.