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

feat: add ark update readme command #1139

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rgee0
Copy link
Contributor

@rgee0 rgee0 commented Nov 20, 2024

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 readme will update each of the three tables in the readme, ready to be committed with their change.

Motivation and Context

  • I have raised an issue to propose this change, which has been given a label of design/approved by a maintainer (required)
    Discussed on the community call

How Has This Been Tested?

Functional

➜  arkade git:(updateReadmeTables) ✗ ./arkade update readme
Updated system table.
Updated apps table.
Updated tools table.
README tables updated successfully

README shows new format as per commit included in this change

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Documentation

  • I have updated the list of tools in README.md if (required) with ./arkade get --format markdown
  • [x ] I have updated the list of apps in README.md if (required) with ./arkade install --help

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have tested this on arm, or have added code to prevent deployment

@rgee0 rgee0 force-pushed the updateReadmeTables branch 2 times, most recently from 0d62388 to f35c6a9 Compare November 20, 2024 21:04
@rgee0 rgee0 marked this pull request as draft November 20, 2024 21:05
@rgee0 rgee0 force-pushed the updateReadmeTables branch from f35c6a9 to eb47b3e Compare November 20, 2024 21:10
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 rgee0 force-pushed the updateReadmeTables branch from eb47b3e to e4800a3 Compare November 20, 2024 21:18
@rgee0 rgee0 marked this pull request as ready for review November 20, 2024 21:21
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.

1 participant