| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
|
Oh and need to update the version bump - I’ll do that in a second. |
Sorry, something went wrong.
|
When you say visually inspected, did you use the sphinx-autobuild to see how it was formatted? |
Sorry, something went wrong.
No, I just previewed in GH, but I'll do that, and fix the warnings / update references. |
Sorry, something went wrong.
|
Don't see any glaring issues now, but let me know what you think, as well as what you think of the order / layout. |
Sorry, something went wrong.
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. |
Sorry, something went wrong.
|
great! I'll take a look shortly |
Sorry, something went wrong.
There was a problem hiding this comment.
@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.
Sorry, something went wrong.
|
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. |
Sorry, something went wrong.
|
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 |
Sorry, something went wrong.
|
Yikes! Feel better 😷 |
Sorry, something went wrong.
|
@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. |
Sorry, something went wrong.
|
Looks really nice... LGTM!
Got it, yes, I noticed the broken link to 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)? |
Sorry, something went wrong.
|
Yep, that's the link, it will exist after a marketplace publish.
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. |
Sorry, something went wrong.
Ooohhh! I didn't realize it was a different repo. Nevermind! |
Sorry, something went wrong.
|
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. |
Sorry, something went wrong.
|
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. |
Sorry, something went wrong.
|
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. |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
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