-
Notifications
You must be signed in to change notification settings - Fork 1
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
feat: add hex publish docs github action #41
Conversation
aed9114
to
3bad968
Compare
- name: Verify Branch | ||
if: github.ref != 'refs/heads/main' | ||
run: exit 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the best way to do it? Should I put this at the job level instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd put it at the job level if
statement. Easier to parse
Don't the docs get published with One other thing I've done before is have the |
This would be for the lastest version that needs some docs refreshing, or adding extra guides and so on to hexdocs |
- name: Verify Branch | ||
if: github.ref != 'refs/heads/main' | ||
run: exit 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd put it at the job level if
statement. Easier to parse
group: hex-publish-docs | ||
cancel-in-progress: true | ||
|
||
jobs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's not a mix package this will be empty and result in null
which I think GHA will error out on. You'll want this to template out to jobs: {}
if it's not a mix package.
I remember I did that initially, but I forgot why I moved to the inside 😭 |
3bad968
to
382d5d9
Compare
382d5d9
to
8189599
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be good
Context
This will allow us to trigger publishing docs only from the trunk branch without creating a new release