diff --git a/.changeset/long-ways-count.md b/.changeset/long-ways-count.md new file mode 100644 index 0000000000..e04c1225cc --- /dev/null +++ b/.changeset/long-ways-count.md @@ -0,0 +1,57 @@ +--- +'@backstage/plugin-techdocs-backend': minor +'@backstage/create-app': patch +--- + +Updated naming of environment variables. New pattern [NAME]\_TOKEN for Github, Gitlab, Azure & Github enterprise access tokens. + +### Detail: + +- Previously we have to export same token for both, catalog & scaffolder + +```bash +export GITHUB_ACCESS_TOKEN=foo +export GITHUB_PRIVATE_TOKEN=foo +``` + +with latest changes, only single export is sufficient. + +```bash +export GITHUB_TOKEN=foo +export GITLAB_TOKEN=foo +export GHE_TOKEN=foo +export AZURE_TOKEN=foo +``` + +### list: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Old nameNew name
GITHUB_ACCESS_TOKENGITHUB_TOKEN
GITHUB_PRIVATE_TOKENGITHUB_TOKEN
GITLAB_ACCESS_TOKENGITLAB_TOKEN
GITLAB_PRIVATE_TOKENGITLAB_TOKEN
AZURE_PRIVATE_TOKENAZURE_TOKEN
GHE_PRIVATE_TOKENGHE_TOKEN
diff --git a/app-config.yaml b/app-config.yaml index d670771a31..228eafc588 100644 --- a/app-config.yaml +++ b/app-config.yaml @@ -67,21 +67,21 @@ integrations: github: - host: github.com token: - $env: GITHUB_PRIVATE_TOKEN + $env: GITHUB_TOKEN ### Example for how to add your GitHub Enterprise instance using the API: # - host: ghe.example.net # apiBaseUrl: https://ghe.example.net/api/v3 # token: - # $env: GHE_PRIVATE_TOKEN + # $env: GHE_TOKEN ### Example for how to add your GitHub Enterprise instance using raw HTTP fetches (token is optional): # - host: ghe.example.net # rawBaseUrl: https://ghe.example.net/raw # token: - # $env: GHE_PRIVATE_TOKEN + # $env: GHE_TOKEN gitlab: - host: gitlab.com token: - $env: GITLAB_PRIVATE_TOKEN + $env: GITLAB_TOKEN bitbucket: - host: bitbucket.org username: @@ -91,7 +91,7 @@ integrations: azure: - host: dev.azure.com token: - $env: AZURE_PRIVATE_TOKEN + $env: AZURE_TOKEN catalog: rules: @@ -102,12 +102,12 @@ catalog: providers: - target: https://github.com token: - $env: GITHUB_PRIVATE_TOKEN + $env: GITHUB_TOKEN #### Example for how to add your GitHub Enterprise instance using the API: # - target: https://ghe.example.net # apiBaseUrl: https://ghe.example.net/api/v3 # token: - # $env: GHE_PRIVATE_TOKEN + # $env: GHE_TOKEN ldapOrg: ### Example for how to add your enterprise LDAP server # providers: @@ -146,18 +146,18 @@ catalog: scaffolder: github: token: - $env: GITHUB_ACCESS_TOKEN + $env: GITHUB_TOKEN visibility: public # or 'internal' or 'private' gitlab: api: baseUrl: https://gitlab.com token: - $env: GITLAB_ACCESS_TOKEN + $env: GITLAB_TOKEN azure: baseUrl: https://dev.azure.com/{your-organization} api: token: - $env: AZURE_PRIVATE_TOKEN + $env: AZURE_TOKEN auth: providers: diff --git a/docs/features/software-templates/extending/create-your-own-publisher.md b/docs/features/software-templates/extending/create-your-own-publisher.md index ecb097f9d9..546980f033 100644 --- a/docs/features/software-templates/extending/create-your-own-publisher.md +++ b/docs/features/software-templates/extending/create-your-own-publisher.md @@ -34,7 +34,7 @@ import { Octokit } from '@octokit/rest'; import type { PluginEnvironment } from '../types'; export default async function createPlugin({ logger }: PluginEnvironment) { - const githubClient = new Octokit({ auth: process.env.GITHUB_ACCESS_TOKEN }); + const githubClient = new Octokit({ auth: process.env.GITHUB_TOKEN }); const publisher = new GithubPublisher({ client: githubClient }); return await createRouter({ diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index 60f73ad0c3..838c5e2d11 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -232,13 +232,13 @@ instance: scaffolder: github: token: - $env: GITHUB_ACCESS_TOKEN + $env: GITHUB_TOKEN visibility: public # or 'internal' or 'private' gitlab: api: baseUrl: https://gitlab.com token: - $env: SCAFFOLDER_GITLAB_PRIVATE_TOKEN + $env: GITLAB_TOKEN ``` #### Azure DevOps @@ -255,7 +255,7 @@ scaffolder: baseUrl: https://dev.azure.com/{your-organization} api: token: - $env: AZURE_PRIVATE_TOKEN + $env: AZURE_TOKEN ``` ### Running the Backend @@ -265,7 +265,7 @@ backend with the new configuration: ```bash cd packages/backend -GITHUB_ACCESS_TOKEN= yarn start +GITHUB_TOKEN= yarn start ``` If you've also set up the frontend plugin, so you should be ready to go browse diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index fb6185d51b..04e2e8f5fc 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -55,7 +55,7 @@ auth: scaffolder: github: token: - $env: GITHUB_ACCESS_TOKEN + $env: GITHUB_TOKEN visibility: public # or 'internal' or 'private' catalog: @@ -66,12 +66,12 @@ catalog: providers: - target: https://github.com token: - $env: GITHUB_PRIVATE_TOKEN + $env: GITHUB_TOKEN # Example for how to add your GitHub Enterprise instance: # - target: https://ghe.example.net # apiBaseUrl: https://ghe.example.net/api/v3 # token: - # $env: GHE_PRIVATE_TOKEN + # $env: GHE_TOKEN locations: # Backstage example components - type: url diff --git a/packages/e2e-test/src/e2e-test.ts b/packages/e2e-test/src/e2e-test.ts index c7f6137ff1..6fbdbf3c88 100644 --- a/packages/e2e-test/src/e2e-test.ts +++ b/packages/e2e-test/src/e2e-test.ts @@ -285,7 +285,7 @@ async function testAppServe(pluginName: string, appDir: string) { cwd: appDir, env: { ...process.env, - GITHUB_ACCESS_TOKEN: 'abc', + GITHUB_TOKEN: 'abc', }, }); Browser.localhost('localhost', 3000); @@ -368,7 +368,7 @@ async function testBackendStart(appDir: string, isPostgres: boolean) { cwd: appDir, env: { ...process.env, - GITHUB_ACCESS_TOKEN: 'abc', + GITHUB_TOKEN: 'abc', }, }); diff --git a/plugins/techdocs-backend/src/default-branch.ts b/plugins/techdocs-backend/src/default-branch.ts index 05a8f666ce..a903b780d8 100644 --- a/plugins/techdocs-backend/src/default-branch.ts +++ b/plugins/techdocs-backend/src/default-branch.ts @@ -69,7 +69,7 @@ function getGithubRequestOptions(config: Config): RequestInit { const token = config.getOptionalString('catalog.processors.github.privateToken') ?? config.getOptionalString('catalog.processors.githubApi.privateToken') ?? - process.env.GITHUB_PRIVATE_TOKEN; + process.env.GITHUB_TOKEN; if (token) { headers.Authorization = `token ${token}`; @@ -88,7 +88,7 @@ function getGitlabRequestOptions(config: Config): RequestInit { const token = config.getOptionalString('catalog.processors.gitlab.privateToken') ?? config.getOptionalString('catalog.processors.gitlabApi.privateToken') ?? - process.env.GITLAB_ACCESS_TOKEN; + process.env.GITLAB_TOKEN; if (token) { headers['PRIVATE-TOKEN'] = token; diff --git a/plugins/techdocs-backend/src/helpers.ts b/plugins/techdocs-backend/src/helpers.ts index d6a275f183..e79df12365 100644 --- a/plugins/techdocs-backend/src/helpers.ts +++ b/plugins/techdocs-backend/src/helpers.ts @@ -126,9 +126,7 @@ export const checkoutGitRepository = async ( process.env.GITLAB_PRIVATE_TOKEN_USER || ''; const token = - process.env.GITHUB_PRIVATE_TOKEN || - process.env.GITLAB_PRIVATE_TOKEN_USER || - ''; + process.env.GITHUB_TOKEN || process.env.GITLAB_PRIVATE_TOKEN_USER || ''; if (fs.existsSync(repositoryTmpPath)) { try {