Skip to content

docs: combine GitHub Actions docs #1011

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

Merged

Conversation

wyardley
Copy link
Contributor

@wyardley wyardley commented Aug 30, 2024

Purpose

Rationale

Having two separate docs with similar filenames for GitHub Actions (one for the action itself, and one on configuring it for automatic release) is a little confusing (see linked ticket).

How did you test?

Visual inspection in the browser

How to Verify

sphinx-autobuild --open-browser docs docs/_build/html

@wyardley
Copy link
Contributor Author

Oh and need to update the version bump - I’ll do that in a second.

@codejedi365
Copy link
Contributor

When you say visually inspected, did you use the sphinx-autobuild to see how it was formatted?

@wyardley
Copy link
Contributor Author

When you say visually inspected, did you use the sphinx-autobuild to see how it was formatted?

No, I just previewed in GH, but I'll do that, and fix the warnings / update references.

@wyardley
Copy link
Contributor Author

Don't see any glaring issues now, but let me know what you think, as well as what you think of the order / layout.
I left the outputs formatted as a table, but left everything else in its original format, and just added another level of titles above the inputs.

@codejedi365
Copy link
Contributor

No, I just previewed in GH, but I'll do that, and fix the warnings / update references.

See the contributors doc for command usage if needed. Try to keep each PR contained so only worry about the warnings related to the part you are changing. we will do the other errors separately or whenever I get around to it.

@codejedi365
Copy link
Contributor

codejedi365 commented Aug 30, 2024

great! I'll take a look shortly

Copy link
Contributor

@codejedi365 codejedi365 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wyardley, this is great work! Thank you for putting in the time. I'm going to add some wording adjustments on top (just my preferences) and hopefully merge it today.

I have added more "good first issue" tags and there are also the "needs-docs" labels if you would rather do documentation changes.

@codejedi365 codejedi365 force-pushed the wyardley/907/docs branch 2 times, most recently from 4f987b3 to e10ce00 Compare September 1, 2024 18:31
@wyardley
Copy link
Contributor Author

wyardley commented Sep 4, 2024

Thanks. @codejedi365 do you want me to look over the changes, or you'll just merge when you get a chance. The updates seem fine to me.

@codejedi365
Copy link
Contributor

I'll just merge them, no problem, thanks. Sorry, I've caught Covid in the last few days so I haven't done much of anything since the weekend

@wyardley
Copy link
Contributor Author

wyardley commented Sep 5, 2024

Yikes! Feel better 😷

@codejedi365
Copy link
Contributor

codejedi365 commented Sep 24, 2024

@wyardley, would you give this a review in the browser in case I missed something (like a link or copy/paste description error). I definitely went overboard with styling (alphabetical inputs/outputs, headings, etc.) and adding a lot more depth to the descriptions and examples. Thank you for giving me the starting point!

Now that I have published the action to the marketplace I was able to simplify the uses directive. Also I added the upload-to-gh-release action details however I have not released it to the marketplace at this moment. I would like to change it over to python-semantic-release-publish as the title which is why the docs spell that out instead.

@wyardley
Copy link
Contributor Author

Looks really nice... LGTM!

I would like to change it over to python-semantic-release-publish as the title which is why the docs spell that out instead.

Got it, yes, I noticed the broken link to
https://github.com/marketplace/actions/python-semantic-release-publish vs https://github.com/marketplace/actions/python-semantic-release

I would say that having it have the same name as the GH project seems like a good idea to me, unless you anticipate needing the existing name for something else? Or is that a second / different action (for upload-to-gh-release)?

@codejedi365
Copy link
Contributor

codejedi365 commented Sep 24, 2024

Yep, that's the link, it will exist after a marketplace publish.

I would say that having it have the same name as the GH project seems like a good idea to me, unless you anticipate needing the existing name for something else? Or is that a second / different action (for upload-to-gh-release)?

I'm not sure I can change the repo name of upload-to-gh-release but I'll try (well not right away as it would break current references). I wanted to just define the sub command of what is actually being called inside the action as a part of the action name. I feel it's more intuitive that way. The action name is just defined in the action.yml so I need to update that file first before I start publishing the second action.

@wyardley
Copy link
Contributor Author

I'm not sure I can change the repo name of upload-to-gh-release

Ooohhh! I didn't realize it was a different repo. Nevermind!
Yeah, if it could be a separate command in the same repo and same action, that would be one thing, but I get what you mean now.

@codejedi365 codejedi365 force-pushed the wyardley/907/docs branch 2 times, most recently from a8630e4 to 02f6b89 Compare September 25, 2024 22:44
@codejedi365
Copy link
Contributor

UPDATE: I have completed the rename/deprecate & release process for the upload-to-gh-release to publish-action actions. This included updating both readmes and adding some deprecation messages. I needed to trigger a release here as well to make sure that all actions stayed inline with the same version. The publish-action is also now published to the marketplace officially and this PR now has all the links matching the new variant.

@codejedi365 codejedi365 merged commit 2135c68 into python-semantic-release:master Sep 27, 2024
5 checks passed
@wyardley
Copy link
Contributor Author

Woot! Great. Sorry to make work for you instead of saving you work, but I think this will all be really helpful to users of the program.

@wyardley wyardley deleted the wyardley/907/docs branch September 27, 2024 22:56
@codejedi365
Copy link
Contributor

Not a problem. I really wish the docs were more thorough and this was a moment of opportunity, and really its most necessary for newcomers that the docs are accurate and detailed. When I find discrepancies or un-intuitive items, I need to address it right away. Ultimately, it also saves me from more open issues in the future.

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

Successfully merging this pull request may close these issues.

GH actions docs inconsistency
2 participants