Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

no documentation built or published with new tag #1128

Closed
prjemian opened this issue Jun 24, 2022 · 10 comments · Fixed by #1127
Closed

no documentation built or published with new tag #1128

prjemian opened this issue Jun 24, 2022 · 10 comments · Fixed by #1127

Comments

@prjemian
Copy link
Contributor

Once the definitions repository was tagged with 2022-06rc0, no new documentation was built or published.

@woutdenolf
How is this supposed to work?

@woutdenolf
Copy link
Contributor

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push

Runs your workflow when you push a commit or tag.

We have

name: Publish Sphinx Docs to GitHub Pages

on:
  # Triggers the workflow on push events but only for the main branch
  push:
    branches:
      - main

So if you push a tag to the main branch, then this section should run

    - name: Publish if refs/tags
      # remove/comment next line to push right away
      if: startsWith(github.ref, 'refs/tags')
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages

@woutdenolf
Copy link
Contributor

woutdenolf commented Jun 24, 2022

I guess you pushed the tag to another branch instead of the main branch directly?

Try this

git checkout main
git tag v2022.06rc1 -m "Release version 2022.06rc1"
git push --tags

Note: no commit or pull request are involved here. You simply push a tag to the main branch.

@prjemian
Copy link
Contributor Author

Appears to be the case. I will tag again and confirm if docs are built & published.

@prjemian
Copy link
Contributor Author

prjemian commented Jun 24, 2022

No publishing workflow run when new tag pushed. Only syntax checks.

@woutdenolf
Copy link
Contributor

woutdenolf commented Jun 24, 2022

The workflow file might need this

name: Publish Sphinx Docs to GitHub Pages

on:
  # Triggers the workflow on push events but only for the main branch
  push:
    branches:
      - main
    tags:
      - '*'  # all tags, but maybe we want to filter for release tags with 'v*'

@prjemian
Copy link
Contributor Author

I agree. Without such a change, the workflow only runs on pushes to main. A new tag only will not pass this test.

prjemian added a commit that referenced this issue Jun 24, 2022
@prjemian
Copy link
Contributor Author

Apparently, Peter a tag, then I pushed the same one (and somehow did not catch his in the process). Thanks for the fix, @woutdenolf !

@woutdenolf
Copy link
Contributor

The docs are deployed: https://nexusformat.github.io/definitions/

But the official webpages links are broken https://www.nexusformat.org/

@woutdenolf
Copy link
Contributor

Ah ok, you made #1129

@prjemian
Copy link
Contributor Author

Also see #1130 for new problem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants