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

This thing does not work #541

Open
MadBomber opened this issue Nov 6, 2024 · 3 comments
Open

This thing does not work #541

MadBomber opened this issue Nov 6, 2024 · 3 comments

Comments

@MadBomber
Copy link

I had such great hope for this utility. I've tried it on two different projects with varying degress of complexity in the actions yaml files. Regardless of which actions yaml file I used as the source I alwasy got the same result:


     _       ____   _____   ___    ___    _   _           ____     ___     ____   ____
    / \     / ___| |_   _| |_ _|  / _ \  | \ | |         |  _ \   / _ \   / ___| / ___|
   / _ \   | |       | |    | |  | | | | |  \| |  _____  | | | | | | | | | |     \___ \
  / ___ \  | |___    | |    | |  | |_| | | |\  | |_____| | |_| | | |_| | | |___   ___) |
 /_/   \_\  \____|   |_|   |___|  \___/  |_| \_|         |____/   \___/   \____| |____/

## Usage

jobs:
  job1:
    uses: ***PROJECT***@***VERSION***
@MadBomber
Copy link
Author

I forgot to mention that I'm using v2.5.0 which I installed via brew

This is how its being executed from my repository root directory:

action-docs -s .github/workflows/jekyll.yml -u README.md

Near the top of my README.md file I have this statement:

<!-- action-docs-all source="action.yml" project="<project>" version="<version>" -->

The documentation of action-docs does not describe what the vale of project are version should be. I've tried it with and without the project and version tags. My README.md file was never updated. The only peep I get out of action-docs is when I drop the -u switch from the command line. That's when I get the generic ascii art I commented on previously.

I'm assuming that action-docs works otherwise how would it have made it to version 2.5.0. The only documentation I have to go on how to use it is its README.md file. Perhaps this is nothing more than a documentation problem. I've also consider that maybe using brew to do the install was not a good thing to do. So I will be uninstalling it and attempting to use the npm install as documented.

@MadBomber
Copy link
Author

I uninstalled the brew installed version then did npm install -g action-docs I get the same version 2.5.0. The same behavior in not generation the documentation for the workflows I have setup for my repository.

Now I'm starting to wonder, is action-docs intended to document the workflows for any random project that uses github actions OR IS IT intended to only document those project which in fact implement a github action for other repositories to use. I'm starting to lean toward this 2nd intent.

Its that's true, then just close this issue.

@npalm
Copy link
Owner

npalm commented Nov 15, 2024

This repo wraps action-docs in a github action. The project is just about generating docs (markdown) for a github action based on the action.ymal.

Sorry not much time for support, it is just os side car.

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

2 participants