sean0x42/markdown-extract

Extract sections of a markdown file. Useful for automatically extracting changelogs

🍌

markdown-extract's Issues

Reduce size of Docker image using alpine or busybox

Currently the completed docker image weights in at around 70mb. It's possible to reduce this using Alpine Linux of busybox instead of debian, bringing the total size down to around 10mb.

The issue is that compilation is more challenging, so more experimentation will be required.

Publish action to the marketplace

You might want to publish the action to the Github Marketplace: https://github.com/marketplace/new

Github Action

This would be an awesome Github Action to generate release changelogs.

Accept markdown source via stdin

A nice additional quality of life feature when no file is provided

Add action to build and test on push

Automatically release notes

This would be a super useful feature, with the following benefits:

• No longer need the Rust/Cargo installed
• GitHub Actions minutes can be saved since less time is spent compiling.

I know there is an action for this somewhere, and we can use a build matrix to achieve cross platform compilation.

Exit with 1 if there are no matches

The tool exits with an error code of 0 and prints No matches. when there are no matches which makes it unnecessarily difficult to determine whether the extraction worked. IMO it should return an error code != 0 by default but introducing a new CLI flag would work as well.

Action doesn't work

The github action passes the filename in as a second argument, but then fails with:

error: Found argument './pr_body' which wasn't expected, or isn't valid in this context

USAGE:
    markdown-extract <pattern> <path> --no-print-matched-heading

For more information try --help
validate test plan

...assuming the filename is "./pr_body" I get the same failure without the leading ./, as well as with an absolute path.

After doing a little bit of research, the workspace in an action is mounted in the container under /github/workspace. So, it'd be nice if either the docs mentioned to prefix files with /github/workspace, or if the action Dockerfile set the workdir to /github/workspace and the docs said to use relative paths.

Or, probably ideally, maybe the binary detects that it's running as an action and does the path translation. Relative path = prefix /github/workspace, absolute path = substitue env $GITHUB_WORKDIR for /github/workspace or alert that the file must be located there if it's not. It's possible to use a different entrypoint in the action metadata. You can specify analternate entrypoint in the action.yml, so this logic could be encapsulated into a shell script which does the arg manipulation and then passes them along to the real program. It could even handle a /github/workspace prefix specially and leave that alone for backwards compatibility.

Provide as Docker image

Hey @sean0x42, thanks for the tool. 👍 Would like to integrate it into our CI pipeline but don't wanna setup a whole Rust/cargo installation. Are you willing to publish markdown-extract as a Docker image? I'm happy to help if you need any support.