Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2.31 KB

README.md

File metadata and controls

77 lines (51 loc) · 2.31 KB
Raw

GitHub JavaScript action template

Join the #publiccode channel Get invited

This is a template repository for creating a GitHub JavaScript action.

Click Use this template button to create your action based on this template.

A sample action to get GitHub star counts and license from a given repository.

Inputs

The following inputs briefly explained here are fully declared and documented in the action.yaml:

  • repo [Required] - GitHub repository to fetch (default ${{ github.repository }})

  • github_token [Optional] - GitHub token to interact with GitHub API (default ${{ github.token }})

Examples

Include this action in your repo by creating .github/workflows/js-action-template.ymland edit where needed:

on: [push, pull_request]

jobs:
  examplejob:
    runs-on: ubuntu-latest
    name: Get Stars and License
    steps:
    - uses: actions/checkout@v2
    - uses: italia/js-action-template@v1
      with:
        repo: "italia/publiccode-parser-action"

Build the action

Install dependencies

npm i

Build the action

npm run build

Contributing

Contributing is always appreciated. Feel free to open issues, fork or submit a Pull Request. If you want to know more about how to add new fields, check out CONTRIBUTING.md.

Maintainers

This software is maintained by the Developers Italia team.

License

© 2021 Dipartimento per la Trasformazione Digitale - Presidenza del Consiglio dei Ministri

Licensed under the EUPL. The version control system provides attribution for specific lines of code.

Remarks

This GitHub Action is published in the Github Marketplace. As such, you can find the Terms of Service here. Also, here you can find the GitHub Marketplace Developer Agreement.