feat: add ark update readme command
#1139
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgee0
force-pushed
the
updateReadmeTables
branch
2 times, most recently
from
0d62388 to
f35c6a9
Compare
rgee0
force-pushed
the
updateReadmeTables
branch
2 times, most recently
from
eb47b3e to
e4800a3
Compare
rgee0
changed the title
ark update readme commandark update readme command
alexellis
reviewed
Feb 28, 2025
cmd/update/readme.go
Outdated
|
|
||
| Cobra is a CLI library for Go that empowers applications. | ||
| This application is a tool to generate the needed files | ||
| to quickly create a Cobra application.`, |
There was a problem hiding this comment.
Could you include the supported markers in the Cobra help message please?
There was a problem hiding this comment.
Yes. Quite the oversight 😆
There was a problem hiding this comment.
Added some detail here
alexellis
requested changes
Feb 28, 2025
rgee0
force-pushed
the
updateReadmeTables
branch
2 times, most recently
from
c4e1b68 to
3e4da5a
Compare
Adds a subcommand to update that will update the README tables in situ. This will be useful to contributors who are adding system installs / apps / tools as it will remove the need for the existing manual mechanism to update the appropriate tables in the readme. Running `arkade update readme` will update each of the three tables in the readme, ready to be committed with their change. Signed-off-by: Richard Gee <[email protected]>
rgee0
force-pushed
the
updateReadmeTables
branch
from
3e4da5a to
99e55ad
Compare
|
We should probably update the PR template once this goes in, as well as the trailing note in the README |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a subcommand to update that will update the README tables in situ. This will be useful to contributors who are adding system installs / apps / tools as it will remove the need for the existing manual mechanism to update the appropriate tables in the readme. Running
arkade update readmewill update each of the three tables in the readme, ready to be committed with their change.Motivation and Context
design/approvedby a maintainer (required)Discussed on the community call
How Has This Been Tested?
Functional
README shows new format as per commit included in this change
Types of changes
Documentation
./arkade get --format markdown./arkade install --helpChecklist:
git commit -s