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

Custom metadata.yaml location #39

Open
barrettj12 opened this issue Jan 17, 2023 · 1 comment
Open

Custom metadata.yaml location #39

barrettj12 opened this issue Jan 17, 2023 · 1 comment

Comments

@barrettj12
Copy link

We are interested in using this action to publish Juju docs (which use a similar structure to charm docs).

As it stands, the metadata.yaml file has to be in the root directory of the repository. For Juju, we don't want to have to add a metadata.yaml in the root directory just for this action to work. We'd be happy to place the metadata.yaml in e.g. the docs or .github directories.

I see two solutions:

  1. Add an action input to allow a custom metadata.yaml location.
    uses: canonical/upload-charm-docs
    with:
      metadata-location: '.github/docs-config.yaml'
  2. Add action inputs to allow specifying the required metadata directly.
    uses: canonical/upload-charm-docs
    with:
      charm-name: 'juju'
      index-page-url: 'https://discourse.charmhub.io/t/juju-olm-documentation/1087'
@barrettj12
Copy link
Author

The custom location would also be needed for multi-charm repos where the charm is not located in the root directory, e.g. the juju dashboard charm.

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

No branches or pull requests

1 participant