diff --git a/README.md b/README.md index 331c25f..34918e8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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` \ No newline at end of file + +### Example project structure + +``` +. +├── LICENSE +├── README.md +├── myproject +│   ├── __init__.py +│   └── myproject.py +├── conda +│   ├── build.sh +│   └── 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` \ No newline at end of file