Files
backstage/plugins/scaffolder-backend-module-github/CHANGELOG.md
T
github-actions[bot] 68db890456 Version Packages (next)
2026-05-26 15:26:38 +00:00

54 KiB

@backstage/plugin-scaffolder-backend-module-github

0.9.10-next.0

Patch Changes

  • Updated dependencies

0.9.9

Patch Changes

  • 3846774: Added missing dependencies that were previously only available transitively.
  • a2ee960: Improved Octokit client creation to support retries via @octokit/plugin-retry
  • Updated dependencies
    • @backstage/catalog-model@1.9.0
    • @backstage/errors@1.3.1
    • @backstage/backend-plugin-api@1.9.1
    • @backstage/plugin-catalog-node@2.2.1
    • @backstage/integration@2.0.2
    • @backstage/plugin-scaffolder-node@0.13.3
    • @backstage/config@1.3.8

0.9.9-next.0

Patch Changes

  • 3846774: Added missing dependencies that were previously only available transitively.
  • Updated dependencies
    • @backstage/errors@1.3.1-next.0
    • @backstage/integration@2.0.2-next.0
    • @backstage/backend-plugin-api@1.9.1-next.0
    • @backstage/catalog-model@1.8.1-next.0
    • @backstage/config@1.3.8-next.0
    • @backstage/plugin-catalog-node@2.2.1-next.0
    • @backstage/plugin-scaffolder-node@0.13.3-next.0
    • @backstage/types@1.2.2

0.9.8

Patch Changes

  • 482ceed: Migrated from assertError to toError for error handling.
  • Updated dependencies
    • @backstage/backend-plugin-api@1.9.0
    • @backstage/errors@1.3.0
    • @backstage/catalog-model@1.8.0
    • @backstage/plugin-catalog-node@2.2.0
    • @backstage/plugin-scaffolder-node@0.13.2
    • @backstage/integration@2.0.1
    • @backstage/config@1.3.7

0.9.8-next.2

Patch Changes

  • 482ceed: Migrated from assertError to toError for error handling.
  • Updated dependencies
    • @backstage/errors@1.3.0-next.0
    • @backstage/plugin-catalog-node@2.2.0-next.2
    • @backstage/plugin-scaffolder-node@0.13.2-next.2
    • @backstage/integration@2.0.1-next.0
    • @backstage/backend-plugin-api@1.9.0-next.2
    • @backstage/catalog-model@1.7.8-next.0
    • @backstage/config@1.3.7-next.0

0.9.8-next.1

Patch Changes

0.9.8-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.8.1-next.0
    • @backstage/plugin-catalog-node@2.1.1-next.0
    • @backstage/plugin-scaffolder-node@0.13.1-next.0
    • @backstage/catalog-model@1.7.7
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7
    • @backstage/integration@2.0.0
    • @backstage/types@1.2.2

0.9.7

Patch Changes

  • a761a48: Added optional returnWorkflowRunDetails input to github:actions:dispatch action. When true, exposes workflowRunId, workflowRunUrl, and workflowRunHtmlUrl as outputs using the GitHub API return_run_details parameter.
  • a49a40d: Updated dependency zod to ^3.25.76 || ^4.0.0 & migrated to /v3 or /v4 imports.
  • b2591f6: Fixed environment waitTime description incorrectly asking for milliseconds instead of minutes.
  • Updated dependencies

0.9.7-next.2

Patch Changes

  • b2591f6: Fixed environment waitTime description incorrectly asking for milliseconds instead of minutes.
  • Updated dependencies

0.9.7-next.1

Patch Changes

  • Updated dependencies
    • @backstage/integration@2.0.0-next.1
    • @backstage/plugin-scaffolder-node@0.13.0-next.1
    • @backstage/plugin-catalog-node@2.1.0-next.1
    • @backstage/backend-plugin-api@1.7.1-next.0
    • @backstage/catalog-model@1.7.6
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.2

0.9.7-next.0

Patch Changes

0.9.6

Patch Changes

  • 7455dae: Use node prefix on native imports
  • 82ca951: cleaned up repo creation to make the unique portions explicit
  • 672b972: Updated dependency libsodium-wrappers to ^0.8.0. Updated dependency @types/libsodium-wrappers to ^0.8.0.
  • 69d880e: Bump to latest zod to ensure it has the latest features
  • Updated dependencies

0.9.6-next.2

Patch Changes

0.9.6-next.1

Patch Changes

0.9.5-next.0

Patch Changes

0.9.4

Patch Changes

  • bb7088b: Added options to set workflow access level for repositories to github:repo:create

    This is useful when creating repositories for GitHub Actions to manage access to the workflows during creation.

     - action: github:repo:create
        id: create-repo
        input:
          repoUrl: github.com?owner=owner&repo=repo
          visibility: private
    +     workflowAccess: organization
    
  • Updated dependencies

0.9.4-next.1

Patch Changes

  • bb7088b: Added options to set workflow access level for repositories to github:repo:create

    This is useful when creating repositories for GitHub Actions to manage access to the workflows during creation.

     - action: github:repo:create
        id: create-repo
        input:
          repoUrl: github.com?owner=owner&repo=repo
          visibility: private
    +     workflowAccess: organization
    

0.9.4-next.0

Patch Changes

0.9.3

Patch Changes

0.9.3-next.1

Patch Changes

0.9.3-next.0

Patch Changes

0.9.2

Patch Changes

0.9.2-next.1

Patch Changes

0.9.2-next.0

Patch Changes

0.9.1

Patch Changes

0.9.1-next.1

Patch Changes

0.9.1-next.0

Patch Changes

0.9.0

Minor Changes

  • f0f06b4: Adding a new scaffolder action github:issues:create following the reference of github:issues:label with dryRun testing possibility

    It can be used like this

      steps:
        - id: create-simple-issue
          name: Create Simple Issue
          action: github:issues:create
          input:
            repoUrl: ${{ parameters.repoUrl }}
            title: "[${{ parameters.projectName }}] Simple Bug Report"
            body: |
              ## Bug Description
              This is a simple bug report created by the scaffolder template.
    
              ### Steps to Reproduce
              1. Run the application
              2. Navigate to the main page
              3. Click on the problematic button
    
              ### Expected Behavior
              The button should work correctly.
    
              ### Actual Behavior
              The button does not respond to clicks.
      output:
        links:
          - title: Simple Issue
            url: ${{ steps['create-simple-issue'].output.issueUrl }}
    

Patch Changes

  • aee107b: Add auto_init option to github:repo:create action to create repository with an initial commit containing a README.md file

    This initial commit is created by GitHub itself and the commit is signed, so the repository will not be empty after creation.

      - action: github:repo:create
        id: init-new-repo
        input:
          repoUrl: 'github.com?repo=repo&owner=owner'
          description: This is the description
          visibility: private
    +     autoInit: true
    
    
  • 6393b78: Add block creations field in github branch protection scaffolder actions

  • Updated dependencies

0.8.3-next.1

Patch Changes

0.8.3-next.0

Patch Changes

0.8.2

Patch Changes

0.8.2-next.1

Patch Changes

  • a22cce0: Fixed bug in the customProperties type which was preventing it being used to set a list of values against a key (e.g. for multi-select fields)

0.8.2-next.0

Patch Changes

0.8.1

Patch Changes

  • f36bcf9: Added support for file deletion to publish:github:pull-request action.

    Example usage:

      - action: publish:github:pull-request
        id: clean-up-pr
        input:
          description: This is the description
    +     filesToDelete:
    +       - outdated/changelog.md
    +       - sample-file.txt
          owner: owner
          repo: repo
          title: Title Goes Here
    
    
  • 38db3eb: Fix typo in InputError

  • Updated dependencies

0.8.1-next.2

Patch Changes

0.8.1-next.1

Patch Changes

0.8.1-next.0

Patch Changes

  • f36bcf9: Added support for file deletion to publish:github:pull-request action.

    Example usage:

      - action: publish:github:pull-request
        id: clean-up-pr
        input:
          description: This is the description
    +     filesToDelete:
    +       - outdated/changelog.md
    +       - sample-file.txt
          owner: owner
          repo: repo
          title: Title Goes Here
    
    
  • Updated dependencies

0.8.0

Minor Changes

  • 5863b04: BREAKING CHANGES

    The createGithubEnvironmentAction action no longer requires an AuthService, and now accepts a CatalogService instead of CatalogClient.

    Unless you're providing your own override action to the default, this should be a non-breaking change.

    You can migrate using the following if you're getting typescript errors:

    import { catalogServiceRef } from '@backstage/plugin-catalog-node';
    import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
    
    export const myModule = createBackendModule({
      pluginId: 'scaffolder',
      moduleId: 'test',
      register({ registerInit }) {
        registerInit({
          deps: {
            scaffolder: scaffolderActionsExtensionPoint,
            catalog: catalogServiceRef,
          },
          async init({ scaffolder, catalog }) {
            scaffolder.addActions(
              createGithubEnvironmentAction({
                catalog,
              }),
            );
          },
        });
      },
    });
    

Patch Changes

0.8.0-next.2

Minor Changes

  • 5863b04: BREAKING CHANGES

    The createGithubEnvironmentAction action no longer requires an AuthService, and now accepts a CatalogService instead of CatalogClient.

    Unless you're providing your own override action to the default, this should be a non-breaking change.

    You can migrate using the following if you're getting typescript errors:

    import { catalogServiceRef } from '@backstage/plugin-catalog-node';
    import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
    
    export const myModule = createBackendModule({
      pluginId: 'scaffolder',
      moduleId: 'test',
      register({ registerInit }) {
        registerInit({
          deps: {
            scaffolder: scaffolderActionsExtensionPoint,
            catalog: catalogServiceRef,
          },
          async init({ scaffolder, catalog }) {
            scaffolder.addActions(
              createGithubEnvironmentAction({
                catalog,
              }),
            );
          },
        });
      },
    });
    

Patch Changes

0.7.2-next.1

Patch Changes

  • Updated dependencies

0.7.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.8.3-next.0
    • @backstage/backend-plugin-api@1.4.0-next.0

0.7.1

Patch Changes

  • 6579c2c: Use action context logger in Octokit client
  • 72d019d: Removed various typos
  • b2b654c: Added optional assignees parameter to publish:github:pull-request action
  • Updated dependencies

0.7.1-next.3

Patch Changes

  • Updated dependencies

0.7.1-next.2

Patch Changes

  • Updated dependencies

0.7.1-next.1

Patch Changes

  • 72d019d: Removed various typos
  • Updated dependencies

0.7.1-next.0

Patch Changes

  • 6579c2c: Use action context logger in Octokit client
  • b2b654c: Added optional assignees parameter to publish:github:pull-request action
  • Updated dependencies

0.7.0

Minor Changes

  • c761cf5: BREAKING The publish:github scaffolder action now defaults to initializing with a branch named "main" instead of "master" when creating new repositories.

    If you or your organization have relied on all new github repositories having a default branch name of "master" you must set the defaultBranch: 'master' in your existing templates that feature the publish:github scaffolder action.

    To keep using the name "master" for your new github repos, these are the required changes:

        - id: publish
          name: Publish
          action: publish:github
          input:
            allowedHosts: ['github.com']
            description: This is ${{ parameters.name }}
            repoUrl: ${{ parameters.repoUrl }}
    +       defaultBranch: 'master'
    

Patch Changes

  • 1af427a: Made "github:autolinks:create" action idempotent
  • 79dc5ac: Made "github:deployKey:create" action idempotent
  • 411c879: Add support to github:repo:create to allow branch updates
  • 180ea6e: Made "github:branch-protection:create" action idempotent
  • 0be1a1e: Made "publish:github" action idempotent
  • a833f0f: Made "github:actions:dispatch" action idempotent
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.8.1
    • @backstage/backend-plugin-api@1.3.0
    • @backstage/integration@1.16.3
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.6.2-next.2

Patch Changes

  • 411c879: Add support to github:repo:create to allow branch updates
  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.3-next.0
    • @backstage/types@1.2.1
    • @backstage/plugin-scaffolder-node@0.8.1-next.1

0.6.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/integration@1.16.3-next.0
    • @backstage/plugin-scaffolder-node@0.8.1-next.1
    • @backstage/backend-plugin-api@1.2.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.6.2-next.0

Patch Changes

  • 1af427a: Made "github:autolinks:create" action idempotent
  • 180ea6e: Made "github:branch-protection:create" action idempotent
  • 0be1a1e: Made "publish:github" action idempotent
  • a833f0f: Made "github:actions:dispatch" action idempotent
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.8.1-next.0
    • @backstage/backend-plugin-api@1.2.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.2
    • @backstage/types@1.2.1

0.6.1

Patch Changes

  • 11bc3e6: Made "github:pages:enable" action idempotent
  • 3f45e0f: Made "github:environment:create" action idempotent
  • 09cf038: Got rid of most @backstage/backend-common usages
  • 8c38687: Made "github:issues:label" action idempotent
  • 89948b2: Made "github:repo:push" action idempotent
  • 9391f58: Pass undefined to some parameters for createOrUpdateEnvironment as these values are not always supported in different plans of GitHub
  • 8182a59: Made "github:webhook" action idempotent
  • 8f9c54c: Made "github:repo:create" action idempotent
  • 0ae0c77: Made "publish:github:pull-request" action idempotent
  • Updated dependencies
    • @backstage/integration@1.16.2
    • @backstage/plugin-scaffolder-node@0.8.0
    • @backstage/backend-plugin-api@1.2.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/types@1.2.1

0.6.1-next.2

Patch Changes

  • 9391f58: Pass undefined to some parameters for createOrUpdateEnvironment as these values are not always supported in different plans of GitHub
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.8.0-next.2
    • @backstage/integration@1.16.2-next.0
    • @backstage/backend-plugin-api@1.2.1-next.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

0.6.1-next.1

Patch Changes

  • 09cf038: Got rid of most @backstage/backend-common usages
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.7.1-next.1
    • @backstage/backend-plugin-api@1.2.1-next.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.1

0.6.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.1-next.0
    • @backstage/plugin-scaffolder-node@0.7.1-next.0

0.6.0

Minor Changes

  • bb8302b: BREAKING: The remoteUrl output is no longer required, it can be empty only when using the new createWhenEmpty boolean flag.

Patch Changes

  • 5c187f9: DEPRECATION: The getOctokitOptions function signature with repoUrl option has been deprecated in favour of a function signature with individual host, owner, and repo parameters:

      const octokitOptions = await getOctokitOptions({
        integrations,
        credentialsProvider,
        token,
    -   repoUrl,
    +   host,
    +   owner,
    +   repo,
      });
    
  • b98d511: clean up github action schemas

  • 5d469c9: Added support for autocompletion of GitHub branches in scaffolder

  • 8e67e4a: Added support for autocompletion to GithubRepoPicker component

  • Updated dependencies

    • @backstage/backend-plugin-api@1.2.0
    • @backstage/plugin-scaffolder-node@0.7.0
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.1

0.6.0-next.2

Minor Changes

  • bb8302b: BREAKING: The remoteUrl output is no longer required, it can be empty only when using the new createWhenEmpty boolean flag.

Patch Changes

  • 5c187f9: DEPRECATION: The getOctokitOptions function signature with repoUrl option has been deprecated in favour of a function signature with individual host, owner, and repo parameters:

      const octokitOptions = await getOctokitOptions({
        integrations,
        credentialsProvider,
        token,
    -   repoUrl,
    +   host,
    +   owner,
    +   repo,
      });
    
  • 5d469c9: Added support for autocompletion of GitHub branches in scaffolder

  • 8e67e4a: Added support for autocompletion to GithubRepoPicker component

  • Updated dependencies

    • @backstage/plugin-scaffolder-node@0.7.0-next.2
    • @backstage/backend-plugin-api@1.2.0-next.2
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.1

0.5.6-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.1
    • @backstage/plugin-scaffolder-node@0.7.0-next.1

0.5.6-next.0

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.2.0-next.0
    • @backstage/plugin-scaffolder-node@0.7.0-next.0
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7
    • @backstage/integration@1.16.1

0.5.5

Patch Changes

  • edaf925: Updates to allow users to subscribe to the newly created repository within GitHub to mimic similar functionality found within the GitHub UI.
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.6.3
    • @backstage/integration@1.16.1
    • @backstage/backend-plugin-api@1.1.1
    • @backstage/catalog-client@1.9.1
    • @backstage/catalog-model@1.7.3
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

0.5.5-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.1-next.1
    • @backstage/catalog-model@1.7.3-next.0
    • @backstage/config@1.3.2-next.0
    • @backstage/errors@1.2.7-next.0
    • @backstage/plugin-scaffolder-node@0.6.3-next.1
    • @backstage/catalog-client@1.9.1-next.0
    • @backstage/integration@1.16.1-next.0

0.5.5-next.1

Patch Changes

  • edaf925: Updates to allow users to subscribe to the newly created repository within GitHub to mimic similar functionality found within the GitHub UI.

0.5.5-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.6.3-next.0
    • @backstage/backend-plugin-api@1.1.1-next.0
    • @backstage/catalog-client@1.9.0
    • @backstage/catalog-model@1.7.2
    • @backstage/config@1.3.1
    • @backstage/errors@1.2.6
    • @backstage/integration@1.16.0

0.5.4

Patch Changes

  • 7df6179: adding requiredLinearHistory property for branch protection settings
  • b5e002b: Change github:environment:create action to request and use a token when resolving reviewer entity refs from the Backstage catalog.
  • e913fdf: Add github backend module to create-app and improve error messages
  • 973dd6f: Minor spell fix in action parameters
  • Updated dependencies
    • @backstage/integration@1.16.0
    • @backstage/backend-plugin-api@1.1.0
    • @backstage/plugin-scaffolder-node@0.6.2
    • @backstage/catalog-client@1.9.0
    • @backstage/errors@1.2.6
    • @backstage/catalog-model@1.7.2
    • @backstage/config@1.3.1

0.5.4-next.2

Patch Changes

  • e913fdf: Add github backend module to create-app and improve error messages
  • Updated dependencies
    • @backstage/backend-plugin-api@1.1.0-next.2
    • @backstage/errors@1.2.6-next.0
    • @backstage/plugin-scaffolder-node@0.6.2-next.2
    • @backstage/catalog-client@1.9.0-next.2
    • @backstage/catalog-model@1.7.2-next.0
    • @backstage/config@1.3.1-next.0
    • @backstage/integration@1.16.0-next.1

0.5.4-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-client@1.9.0-next.1
    • @backstage/plugin-scaffolder-node@0.6.2-next.1
    • @backstage/backend-plugin-api@1.1.0-next.1
    • @backstage/catalog-model@1.7.1
    • @backstage/config@1.3.0
    • @backstage/errors@1.2.5
    • @backstage/integration@1.16.0-next.0

0.5.3-next.0

Patch Changes

  • Updated dependencies
    • @backstage/integration@1.16.0-next.0
    • @backstage/backend-plugin-api@1.0.3-next.0
    • @backstage/plugin-scaffolder-node@0.6.1-next.0
    • @backstage/catalog-client@1.8.1-next.0
    • @backstage/catalog-model@1.7.1
    • @backstage/config@1.3.0
    • @backstage/errors@1.2.5

0.5.2

Patch Changes

  • Updated dependencies
    • @backstage/catalog-client@1.8.0
    • @backstage/config@1.3.0
    • @backstage/backend-plugin-api@1.0.2
    • @backstage/plugin-scaffolder-node@0.6.0
    • @backstage/catalog-model@1.7.1
    • @backstage/errors@1.2.5
    • @backstage/integration@1.15.2

0.5.2-next.3

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.2-next.2
    • @backstage/catalog-client@1.8.0-next.1
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.15.1
    • @backstage/plugin-scaffolder-node@0.5.1-next.3

0.5.2-next.2

Patch Changes

  • Updated dependencies
    • @backstage/catalog-client@1.8.0-next.1
    • @backstage/backend-plugin-api@1.0.2-next.2
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.15.1
    • @backstage/plugin-scaffolder-node@0.5.1-next.2

0.5.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@1.0.2-next.1
    • @backstage/catalog-client@1.8.0-next.0
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.15.1
    • @backstage/plugin-scaffolder-node@0.5.1-next.1

0.5.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-client@1.8.0-next.0
    • @backstage/backend-plugin-api@1.0.2-next.0
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.15.1
    • @backstage/plugin-scaffolder-node@0.5.1-next.0

0.5.1

Patch Changes

  • 8ce0c4c: Add github:branch-protection:create scaffolder action to set branch protection on an existing repository. Example usage:

    - id: set-branch-protection
      name: Set Branch Protection
      action: github:branch-protection:create
      input:
        repoUrl: 'github.com?repo=backstage&owner=backstage'
        branch: master
        enforceAdmins: true # default
        requiredApprovingReviewCount: 1 # default
        requireBranchesToBeUpToDate: true # default
        requireCodeOwnerReviews: true
        dismissStaleReviews: true
        requiredConversationResolution: true
    
  • 094eaa3: Remove references to in-repo backend-common

  • Updated dependencies

    • @backstage/plugin-scaffolder-node@0.5.0
    • @backstage/integration@1.15.1
    • @backstage/catalog-client@1.7.1
    • @backstage/backend-plugin-api@1.0.1
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

0.5.1-next.2

Patch Changes

  • 8ce0c4c: Add github:branch-protection:create scaffolder action to set branch protection on an existing repository. Example usage:

    - id: set-branch-protection
      name: Set Branch Protection
      action: github:branch-protection:create
      input:
        repoUrl: 'github.com?repo=backstage&owner=backstage'
        branch: master
        enforceAdmins: true # default
        requiredApprovingReviewCount: 1 # default
        requireBranchesToBeUpToDate: true # default
        requireCodeOwnerReviews: true
        dismissStaleReviews: true
        requiredConversationResolution: true
    
  • Updated dependencies

    • @backstage/integration@1.15.1-next.1
    • @backstage/catalog-client@1.7.1-next.0
    • @backstage/plugin-scaffolder-node@0.5.0-next.2
    • @backstage/backend-plugin-api@1.0.1-next.1
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

0.5.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/integration@1.15.1-next.0
    • @backstage/backend-plugin-api@1.0.1-next.0
    • @backstage/catalog-client@1.7.0
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/plugin-scaffolder-node@0.5.0-next.1

0.5.1-next.0

Patch Changes

  • 094eaa3: Remove references to in-repo backend-common
  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.5.0-next.0
    • @backstage/backend-plugin-api@1.0.1-next.0
    • @backstage/catalog-client@1.7.0
    • @backstage/catalog-model@1.7.0
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.15.0

0.5.0

Minor Changes

  • d425fc4: BREAKING: The return values from createBackendPlugin, createBackendModule, and createServiceFactory are now simply BackendFeature and ServiceFactory, instead of the previously deprecated form of a function that returns them. For this reason, createServiceFactory also no longer accepts the callback form where you provide direct options to the service. This also affects all coreServices.* service refs.

    This may in particular affect tests; if you were effectively doing createBackendModule({...})() (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your packages/backend/src/index.ts too, where you add plugins, modules, and services. If you were using createServiceFactory with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.

    As part of this change, the IdentityFactoryOptions type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to migrate to the new auth system if you still rely on it.

Patch Changes

  • 22a19e6: Added the ability for the actions publish:github and github:repo:create to take inputs for 'custom properties' for organization repositories.

  • 162cdf4: Update dependency @octokit/webhooks to 10.9.2 due to SNYK-JS-OCTOKITWEBHOOKS-6129527

  • 7976081: Added support for all request parameters in the Github create/update environment API in the Github environment create scaffolder action.

    Disable MultiEntityPicker when maxItems limit is reached defined in JSONSchema

  • Updated dependencies

0.5.0-next.2

Patch Changes

  • 22a19e6: Added the ability for the actions publish:github and github:repo:create to take inputs for 'custom properties' for organization repositories.
  • Updated dependencies

0.5.0-next.1

Patch Changes

0.5.0-next.0

Minor Changes

  • d425fc4: BREAKING: The return values from createBackendPlugin, createBackendModule, and createServiceFactory are now simply BackendFeature and ServiceFactory, instead of the previously deprecated form of a function that returns them. For this reason, createServiceFactory also no longer accepts the callback form where you provide direct options to the service. This also affects all coreServices.* service refs.

    This may in particular affect tests; if you were effectively doing createBackendModule({...})() (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your packages/backend/src/index.ts too, where you add plugins, modules, and services. If you were using createServiceFactory with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.

    As part of this change, the IdentityFactoryOptions type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to migrate to the new auth system if you still rely on it.

Patch Changes

0.4.1

Patch Changes

  • d21d307: Added examples for github:environment:create action and improve its test cases
  • 6d4cb97: Added examples for github:repo:create action and improved test cases
  • cd203f1: Added examples for action github:pages and improved its test cases
  • Updated dependencies

0.4.1-next.3

Patch Changes

  • 6d4cb97: Added examples for github:repo:create action and improved test cases
  • cd203f1: Added examples for action github:pages and improved its test cases
  • Updated dependencies

0.4.1-next.2

Patch Changes

0.4.1-next.1

Patch Changes

  • d21d307: Added examples for github:environment:create action and improve its test cases
  • Updated dependencies

0.4.1-next.0

Patch Changes

0.4.0

Minor Changes

  • 70c4b36: Adds support for custom tag policies when creating GitHub environments.

Patch Changes

  • ccfc9d1: Fixed bug resulting from missing required owner and repo arguments in getEnvironmentPublicKey in action github:environment:create.

    Adding environment secrets now works as expected.

  • 141f366: Added action to enable GitHub Pages on a repo

  • 4410fed: Fixed issue with octokit call missing owner and repo when creating environment variables and secrets using github:environment:create action

  • dfaa28d: Adds requireLastPushApproval input property to configure Branch Protection Settings in github:publish action

    Adds requireLastPushApproval input property to configure Branch Protection Settings in github:repo:push action

  • Updated dependencies

0.4.0-next.1

Patch Changes

  • 141f366: Added action to enable GitHub Pages on a repo

  • dfaa28d: Adds requireLastPushApproval input property to configure Branch Protection Settings in github:publish action

    Adds requireLastPushApproval input property to configure Branch Protection Settings in github:repo:push action

  • Updated dependencies

0.4.0-next.0

Minor Changes

  • 70c4b36: Adds support for custom tag policies when creating GitHub environments.

Patch Changes

  • 4410fed: Fixed issue with octokit call missing owner and repo when creating environment variables and secrets using github:environment:create action
  • Updated dependencies

0.3.0

Minor Changes

  • 403394a: Allow empty author info in createPullRequest action for Github

Patch Changes

  • f145a04: Added handling for dry run to githubPullRequest and githubWebhook and added tests for this functionality
  • 78a0b08: Internal refactor to handle BackendFeature contract change.
  • d44a20a: Added additional plugin metadata to package.json.
  • Updated dependencies

0.3.0-next.3

Patch Changes

0.3.0-next.2

Minor Changes

  • 403394a: Allow empty author info in createPullRequest action for Github

Patch Changes

0.2.9-next.1

Patch Changes

  • Updated dependencies

0.2.9-next.0

Patch Changes

  • f145a04: Added handling for dry run to githubPullRequest and githubWebhook and added tests for this functionality
  • Updated dependencies

0.2.8

Patch Changes

  • 5d99272: Update local development dependencies.
  • d229dc4: Move path utilities from backend-common to the backend-plugin-api package.
  • 52ab241: Adding support to change the default commit author for publish:github:pull-request
  • Updated dependencies

0.2.8-next.2

Patch Changes

0.2.8-next.1

Patch Changes

  • Updated dependencies

0.2.8-next.0

Patch Changes

0.2.7

Patch Changes

0.2.7-next.1

Patch Changes

  • 33f958a: Improve examples to ensure consistency across all publish actions
  • Updated dependencies

0.2.7-next.0

Patch Changes

0.2.6

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.21.6
    • @backstage/backend-plugin-api@0.6.16
    • @backstage/plugin-scaffolder-node@0.4.2
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.9.1

0.2.5

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.21.5
    • @backstage/plugin-scaffolder-node@0.4.1
    • @backstage/backend-plugin-api@0.6.15
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/integration@1.9.1

0.2.4

Patch Changes

  • f44589d: Introduced createMockActionContext to unify the way of creating scaffolder mock context.

    It will help to maintain tests in a long run during structural changes of action context.

  • 35fe005: Export getOctokitOptions for easy re-use of Octokit configuration handling

  • 1753898: Updated dependency octokit-plugin-create-pull-request to ^5.0.0.

  • Updated dependencies

    • @backstage/plugin-scaffolder-node@0.4.0
    • @backstage/backend-common@0.21.4
    • @backstage/integration@1.9.1
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/backend-plugin-api@0.6.14

0.2.4-next.2

Patch Changes

  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.4.0-next.2
    • @backstage/integration@1.9.1-next.2
    • @backstage/backend-common@0.21.4-next.2
    • @backstage/backend-plugin-api@0.6.14-next.2
    • @backstage/config@1.2.0-next.1
    • @backstage/errors@1.2.4-next.0

0.2.4-next.1

Patch Changes

  • 35fe005: Export getOctokitOptions for easy re-use of Octokit configuration handling
  • Updated dependencies
    • @backstage/config@1.2.0-next.1
    • @backstage/plugin-scaffolder-node@0.4.0-next.1
    • @backstage/backend-common@0.21.4-next.1
    • @backstage/backend-plugin-api@0.6.14-next.1
    • @backstage/integration@1.9.1-next.1
    • @backstage/errors@1.2.4-next.0

0.2.3-next.0

Patch Changes

  • f44589d: Introduced createMockActionContext to unify the way of creating scaffolder mock context.

    It will help to maintain tests in a long run during structural changes of action context.

  • 1753898: Updated dependency octokit-plugin-create-pull-request to ^5.0.0.

  • Updated dependencies

    • @backstage/backend-common@0.21.3-next.0
    • @backstage/errors@1.2.4-next.0
    • @backstage/plugin-scaffolder-node@0.3.3-next.0
    • @backstage/backend-plugin-api@0.6.13-next.0
    • @backstage/config@1.1.2-next.0
    • @backstage/integration@1.9.1-next.0

0.2.0

Minor Changes

  • fd5eb1c: Allow to force the creation of a pull request from a forked repository
  • 3d5c668: support oidc customization

Patch Changes

  • e9a5228: Exporting a default module for the new Backend System
  • 8472188: Added or fixed the repository field in package.json.
  • 6bb6f3e: Updated dependency fs-extra to ^11.2.0. Updated dependency @types/fs-extra to ^11.0.0.
  • Updated dependencies
    • @backstage/backend-common@0.21.0
    • @backstage/backend-plugin-api@0.6.10
    • @backstage/integration@1.9.0
    • @backstage/plugin-scaffolder-node@0.3.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.2.0-next.3

Patch Changes

  • 8472188: Added or fixed the repository field in package.json.
  • Updated dependencies
    • @backstage/backend-common@0.21.0-next.3
    • @backstage/integration@1.9.0-next.1
    • @backstage/plugin-scaffolder-node@0.3.0-next.3
    • @backstage/backend-plugin-api@0.6.10-next.3
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.2.0-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.21.0-next.2
    • @backstage/backend-plugin-api@0.6.10-next.2
    • @backstage/plugin-scaffolder-node@0.3.0-next.2
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/integration@1.9.0-next.0

0.2.0-next.1

Minor Changes

  • fd5eb1c: Allow to force the creation of a pull request from a forked repository

Patch Changes

  • Updated dependencies
    • @backstage/backend-plugin-api@0.6.10-next.1
    • @backstage/backend-common@0.21.0-next.1
    • @backstage/integration@1.9.0-next.0
    • @backstage/plugin-scaffolder-node@0.3.0-next.1
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.2-next.0

Patch Changes

  • e9a5228: Exporting a default module for the new Backend System
  • Updated dependencies
    • @backstage/backend-common@0.21.0-next.0
    • @backstage/plugin-scaffolder-node@0.3.0-next.0
    • @backstage/backend-plugin-api@0.6.10-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/integration@1.8.0

0.1.1

Patch Changes

  • 5470300: Ensure teamReviewers list is unique before calling API
  • bf92ae3: Updated dependency octokit to ^3.0.0.
  • Updated dependencies
    • @backstage/backend-common@0.20.1
    • @backstage/plugin-scaffolder-node@0.2.10
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/integration@1.8.0

0.1.1-next.2

Patch Changes

0.1.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.20.1-next.1
    • @backstage/integration@1.8.0
    • @backstage/config@1.1.1
    • @backstage/plugin-scaffolder-node@0.2.10-next.1
    • @backstage/errors@1.2.3

0.1.1-next.0

Patch Changes

  • bf92ae3: Updated dependency octokit to ^3.0.0.
  • Updated dependencies
    • @backstage/backend-common@0.20.1-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/integration@1.8.0
    • @backstage/plugin-scaffolder-node@0.2.10-next.0

0.1.0

Minor Changes

  • 219d7f0: Create new scaffolder module for external integrations

Patch Changes

  • cb6a65e: The scaffolder.defaultCommitMessage config value is now being used if provided and uses "initial commit" when it is not provided.
  • 28949ea: Add a new action for creating github-autolink references for a repository: github:autolinks:create
  • Updated dependencies
    • @backstage/backend-common@0.20.0
    • @backstage/plugin-scaffolder-node@0.2.9
    • @backstage/integration@1.8.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

0.1.0-next.0

Minor Changes

  • 219d7f0: Create new scaffolder module for external integrations

Patch Changes

  • Updated dependencies
    • @backstage/plugin-scaffolder-node@0.2.9-next.3
    • @backstage/backend-common@0.20.0-next.3
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/integration@1.8.0-next.1