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.

Sign up for GitHub

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

Jump to bottom

Support for regular workflows? #240

Closed
gj250116 opened this issue Jun 21, 2022 · 7 comments
Closed

Support for regular workflows? #240

gj250116 opened this issue Jun 21, 2022 · 7 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@gj250116
Copy link

gj250116 commented Jun 21, 2022 •
edited
Loading

Is there support for workflows apart from regular actions?
For example:

name: Workflow

on:
  workflow_call:
    inputs:
      input1:
        description: "Input1"
        required: false

    outputs:
      output1:
        description: "Output1"
        required: false

jobs:
  backend-deploy:
    runs-on: ubuntu-latest
    steps: 
      - name: 'Checkout' 
        uses: actions/checkout@v2

This errors out with: Cannot read properties of undefined (reading 'using')
@geirsagberg
Copy link

Maybe the script could detect if it is an action or a workflow, e.g. looking for on:?

@deavisdude
Copy link

This is exactly the functionality I am looking for, has anyone figured out a solution? Would love to have this work for reusable workflows as well

@npalm
Copy link
Owner

npalm commented Oct 10, 2022

No support yet, but open to any improvement.

@ali-kafel
Copy link

I'm bumping this as well, would be great feature for reusable workflows

@npalm npalm added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Mar 2, 2023
@npalm
Copy link
Owner

npalm commented Apr 7, 2023

Never thought about this but would be nice if we can support reusable workflwos to generate documentation

@larmitage-bjss
Copy link
Contributor

Hello, I'm taking a look at this. Not written a js/ts cli app before though so would love feedback when I can put up a first draft PR please

larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 move test fixtures to folders to separate action and work…
36dc07a 
…flow tests
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 duplicate tests for workflows
538098b
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 upgrade packages to remove vulnerabilities
2eb4972
@larmitage-bjss larmitage-bjss mentioned this issue Feb 13, 2024
Closed
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 upgrade packages to remove vulnerabilities
9e41f88
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 move test fixtures to folders to separate action and work…
1170ddd 
…flow tests
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 duplicate tests for workflows
9a7e402
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge pull request #2 from larmitage-bjss/npalmGH-240-upgrade-packages
21ebdb2 
npalmGH-240 upgrade packages to remove vulnerabilities
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 update CONTRIBUTING where command does not work and add a…
09dec15 
…dditional helper scripts
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge remote-tracking branch 'origin' into npalmGH-240-support-workflows
945278b
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge pull request #3 from larmitage-bjss/npalmGH-240-update-docs
94a2b15 
npalmGH-240 update CONTRIBUTING where command does not work and add additi…
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge remote-tracking branch 'origin' into npalmGH-240-support-workflows
83bcb62
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 add option to have a top level header containing the name
3613525
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 add option to have a top level header containing the name
d1d69a1
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 add header to readme and tests
e2abbb2
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge pull request #4 from larmitage-bjss/npalmGH-240-add-name-header
8fc1b70 
npalmGH-240 add option to have a top level header containing the name
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
npalmGH-240 fix error with enum
8bb6a3e
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 13, 2024
@larmitage-bjss
Merge remote-tracking branch 'origin' into npalmGH-240-support-workflows
8df7c09
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 14, 2024
@larmitage-bjss
npalmGH-240 ability to display workflow inputs and outputs
ef810cc
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 14, 2024
@larmitage-bjss
npalmGH-240 add usage
d55f6e5
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 14, 2024
@larmitage-bjss
npalmGH-240 start adding workflow tests
a4d2096
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 update name header shorthand to nh
239a0f4
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 update name header shorthand to n
355f36e
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
Merge remote-tracking branch 'origin' into npalmGH-240-support-workflows
7c7a563
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 fix test for readme
62f6db3
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 fix test for readme
3cd97c2
npalm added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@npalm
Merge branch 'main' into npalmGH-240-add-name-header
a117354
npalm added a commit that referenced this issue Feb 15, 2024
@larmitage-bjss @npalm
feat: support action name attribute (#526)
0e99848 
* GH-240 update CONTRIBUTING where command does not work and add additional helper scripts

* GH-240 add option to have a top level header containing the name

* GH-240 add header to readme and tests

* GH-240 update name header shorthand to nh

* GH-240 update name header shorthand to n

---------

Co-authored-by: Niek Palm <[email protected]>
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 all fields readme test working
53c9432
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 sort out renaming of action > workflow of test files
4ba7bae
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 fix crlf test
513cd72
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 all tests fixed
f67990f
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 amend readme for workflow functionality
664685e
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
Merge remote-tracking branch 'origin' into npalmGH-240-support-workflows
971fa99
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 add back in new lines at end of files
e2ffb77
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 add back in new lines at end of files
8389a6e
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 15, 2024
@larmitage-bjss
npalmGH-240 tweak to readme to clarify description is only for actions
c0b7bb8
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Feb 16, 2024
@larmitage-bjss
Merge branch 'main' into npalmGH-240-support-workflows
94ee9e1
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
Merge remote-tracking branch 'upstream/main' into npalmGH-240-support…
6b83e08 
…-workflows
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
npalmGH-240 Fix tests
e43eb79
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
npalmGH-240 fix workflow syntax
0c947f7
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
npalmGH-240 add source option and deprecate action option
39d9cc9
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
npalmGH-240 Make replace in readme backwards compatible with source/a…
bd71f41 
…ction
larmitage-bjss added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@larmitage-bjss
npalmGH-240 add backwards compatibility test
dfa6c51
npalm added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 5, 2024
@npalm
Merge branch 'main' into npalmGH-240-support-workflows
d2b41a4
@npalm npalm mentioned this issue Mar 6, 2024
Merged
npalm added a commit to larmitage-bjss/fork-action-docs that referenced this issue Mar 6, 2024
@npalm
Merge branch 'main' into npalmGH-240-support-workflows
a207a86
npalm added a commit that referenced this issue Mar 6, 2024
@larmitage-bjss @npalm
feat: support document generation for workflows (#523)
f043f7f 
* GH-240 upgrade packages to remove vulnerabilities

* GH-240 move test fixtures to folders to separate action and workflow tests

* GH-240 duplicate tests for workflows

* GH-420 add run scripts to run action/workflow manually and run tests for action/workflow separately

* WIP

* GH-240 update CONTRIBUTING where command does not work and add additional helper scripts

* GH-240 add option to have a top level header containing the name

* GH-240 add header to readme and tests

* Remove unused files

* GH-240 fix error with enum

* GH-240 ability to display workflow inputs and outputs

* GH-240 add usage

* GH-240 start adding workflow tests

* GH-240 get a few more workflow tests working

* Update action test files with main

* GH-240 fix test for readme

* GH-240 all fields readme test working

* GH-240 sort out renaming of action > workflow of test files

* GH-240 fix crlf test

* GH-240 all tests fixed

* GH-240 amend readme for workflow functionality

* GH-240 add back in new lines at end of files

* GH-240 tweak to readme to clarify description is only for actions

* GH-240 Fix tests

* GH-240 fix workflow syntax

* GH-240 add source option and deprecate action option

* GH-240 Make replace in readme backwards compatible with source/action

* GH-240 add backwards compatibility test

* Fix missed -a to -s in readme

Co-authored-by: Niek Palm <[email protected]>

* GH-420 rename ActionYml to YmlStructure, and actionFile to sourceFile

---------

Co-authored-by: Niek Palm <[email protected]>
npalm pushed a commit that referenced this issue Mar 9, 2024
@larmitage-bjss
feat: add 'all' option to add all the documentation to the readme in …
dc70838 
…one go (#537)

* GH-240 upgrade packages to remove vulnerabilities

* GH-240 move test fixtures to folders to separate action and workflow tests

* GH-240 duplicate tests for workflows

* GH-420 add run scripts to run action/workflow manually and run tests for action/workflow separately

* WIP

* GH-240 update CONTRIBUTING where command does not work and add additional helper scripts

* GH-240 add option to have a top level header containing the name

* GH-240 add header to readme and tests

* Remove unused files

* GH-240 fix error with enum

* GH-240 ability to display workflow inputs and outputs

* GH-240 add usage

* GH-240 start adding workflow tests

* GH-240 get a few more workflow tests working

* Update action test files with main

* GH-240 fix test for readme

* GH-240 all fields readme test working

* GH-240 sort out renaming of action > workflow of test files

* GH-240 fix crlf test

* GH-240 all tests fixed

* GH-240 amend readme for workflow functionality

* GH-240 add back in new lines at end of files

* GH-240 tweak to readme to clarify description is only for actions

* Add 'all' option to add docs to readme

* Tidy up from merge
@npalm
Copy link
Owner

npalm commented Mar 10, 2024

supported since release 2.2.0

@npalm npalm closed this as completed Mar 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@geirsagberg @deavisdude @npalm @gj250116 @ali-kafel @larmitage-bjss