init-repo-action

Internal (personal) Action to Init my Repositories following my internal rules

This personal action was created to can have an unique code/procedure to create my repor whatever the context.

Actually my repositories can be created from:

• a repository tool as my dynamic-template-tool action,
• or as a Dynamic Template: directly from the template creation procedure as in my template-common-js. This last case is only possible when the new repositories is created inside an organization, where needed secrets can be available globally.

Behaviour

• Create the new repository defined by repository from the specified template (if asked)
• Checkout the new repository defined by repository
• Manage ssh cnx to the repository specified by repository_deployment with the help of the generate-ssh-deploy-repo-action action, if repository_deployment is defined.
• Create the linked TestSpace Project with the help of the fletort/testspace-create-action action in the specified testspace_domain if asked with testspace_link_enable parameter.
• Create a develop branch on the new repository
• Define main and develop branch protection
• Manage Dynamic Template Substitution with the help of the fletort/jinja2-template-action action.
• Remove AutoInit Workflow (this feature can be disabled with the delete-workflow option):
  • on a Dynamic Template (repo that init itself), the current workflow file (calling the current action) is deleted
  • on a tool behaviour (repo targeted is not the repo calling the action), workflow contening a call to the current action are deleted (such workflow exist if the repo is created from a Template with Dynamic Feature)
• Rename all directorie from the template that beging with the $ character. For example the $.github directory will be renamed to .github. If the final directory exists, it is replaced with the content of the renamed directory.
• Create the Pull Request for this Template resolution code modification with the help of peter-evans/create-pull-request action.

We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary. Learn more about creating and using encrypted secrets

Usage

Used as a tool

- uses: fletort/init-repo-action@v1
  with:
    repository: owner/my_repo_to_create
    template: owner/my_template_repo
    repository_deployment: owner/repo_on_which_we_can_deploy
    token: ${{ secrets.PAT }}
    testspace_link_enable: true
    testspace_token: ${{ secrets.TESTSPACE_TOKEN }}
    testspace_domain: testspace_domain

You can also pin to a specific release version in the format @v1.x.x

Used from a repo that init itself

- uses: fletort/init-repo-action@v1
  with:
    repository_deployment: owner/repo_on_which_we_can_deploy
    token: ${{ secrets.PAT }}
    testspace_link_enable: true
    testspace_token: ${{ secrets.TESTSPACE_TOKEN }}

You can also pin to a specific release version in the format @v1.x.x

To have a dynamic template feature you can call this action on the create event:

name: Init Repository and Resolve Dynamic Template
on:
  - create

jobs:
  init_repo:
    name: Init Repository
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: Checkout
        id: checkout
        uses: fletort/init-repo-action@v1
        with:
          repository_deployment: owner/repo_on_which_we_can_deploy
          token: ${{ secrets.PAT }}
          testspace_link_enable: true
          testspace_token: ${{ secrets.TESTSPACE_TOKEN }}

See my template-common-js template init workflow for an up to date Dynamic Template worflow

Actions inputs

Only inputs specified in the "init itself" usage upper are mandatories. All other inputs are optional.

token

The token must have the following permissions:

• 'Repository Administration':
  • To can create the repository (if requested i.e. if a template is defined)
  • To be able to add a publish key to the repository_deployment
• 'Repository Contents': To be able to Fetch the repository and commit to the repository
• 'Repository Secrets': Store secret inside the repository
• 'Repository Pull Requests': To be able to create the PR on the repository with the template resolution
• 'Repository Worflows': Needed, if you are using directory renaming feature to create the .github directory (from a template $.github directory)

Template Specific Content

As this action used the fletort/jinja2-template-action, your template can include jinja2 syntax. See official Jinja2 Template Designer Documentation.

Code Quality

All unit/functional test executed on each branch/PR are listed/described on this testspace space.

2 functionals (integration) testsuites are executed on github pipelines

and tests results are send to TestSpace:

For exemple the "tool" test suite contains the following tests:

• The Tool scenario tests the role in "a tool way", i.e. targeting a remote repository that is created by the role itself. In this case, we are also testing that we are able to define variable from data file on the jinja2 sub-action (test the link between this actions inputs and the sub-action)
• The AutoInit scenario tests the role in "Dynamic Template way", i.e. a repository that is using the role on itself. In this case, we are also testing that we are able to ask to jinja2 sub-action to keep original template file. (test the link between this actions inputs and the sub-action)
• The publishing feature is tested only in one of the scenario, and appears as a third test suite on TestSpace side.
• The No Testspace scenario tests the role when TestSpace creation feature is disabled
• The No Deployment scenario tests the role when Deployment feature is disabled

License

The scripts and documentation in this project are released under the MIT License