diff --git a/.github/workflows/pr-size-labeler.yml b/.github/workflows/pr-size-labeler.yml new file mode 100644 index 0000000000..95d01ab8c4 --- /dev/null +++ b/.github/workflows/pr-size-labeler.yml @@ -0,0 +1,28 @@ +name: pr-size + +on: [pull_request] + +jobs: + labeler: + runs-on: ubuntu-latest + name: Label the PR size + steps: + - uses: codelytv/pr-size-labeler@v1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + xs_label: 'size/xs' + xs_max_size: '10' + s_label: 'size/s' + s_max_size: '100' + m_label: 'size/m' + m_max_size: '500' + l_label: 'size/l' + l_max_size: '1000' + xl_label: 'size/xl' + # fail_if_xl: 'false' + # message_if_xl: > + # This PR exceeds the recommended size of 1000 lines. + # Please make sure you are NOT addressing multiple issues with one PR. + # Note this PR might be rejected due to its size. + github_api_url: 'https://api.github.com' + files_to_ignore: '' diff --git a/.gitignore b/.gitignore index 513519040a..4819c06037 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,6 @@ output .cover .terraform/ node_modules/ -**/.vuepress/* helm/test-values.yaml *.swp golangci-lint @@ -30,3 +29,9 @@ tmp-CHANGELOG.md # draw.io backup files *.bkp + +# vuepress +**/.vuepress/* +!runatlantis.io/.vuepress/config.* +!runatlantis.io/.vuepress/navbar.* +!runatlantis.io/.vuepress/sidebar.* diff --git a/runatlantis.io/.vuepress/config.js b/runatlantis.io/.vuepress/config.js index e264eefd9f..fb042ca3c3 100644 --- a/runatlantis.io/.vuepress/config.js +++ b/runatlantis.io/.vuepress/config.js @@ -5,6 +5,8 @@ import { defaultTheme } from '@vuepress/theme-default'; import { defineUserConfig } from 'vuepress'; import { sitemapPlugin } from '@vuepress/plugin-sitemap'; import { webpackBundler } from '@vuepress/bundler-webpack'; +import navbar from "./navbar"; +import sidebar from "./sidebar"; const __dirname = getDirname(import.meta.url) @@ -85,13 +87,7 @@ export default defineUserConfig({ locales: { '/': { selectLanguageName: 'English', - navbar: [ - { text: 'Home', link: '/' }, - { text: 'Guide', link: '/guide/' }, - { text: 'Docs', link: '/docs/' }, - { text: "Contributing", link: "/contributing/" }, - { text: 'Blog', link: 'https://medium.com/runatlantis' }, - ], + navbar: navbar.en, }, /* '/es/': { @@ -105,101 +101,7 @@ export default defineUserConfig({ }, */ }, - sidebar: { - '/guide/': [ - '/guide/', - '/guide/test-drive', - '/guide/testing-locally', - ], - '/docs/': [ - { - text: 'Installing Atlantis', - collapsible: true, - children: [ - '/docs/installation-guide', - '/docs/requirements', - '/docs/access-credentials', - '/docs/webhook-secrets', - '/docs/deployment', - '/docs/configuring-webhooks', - '/docs/provider-credentials', - ] - }, - { - text: 'Configuring Atlantis', - collapsible: true, - children: [ - { - text: 'Overview', - link: '/docs/configuring-atlantis', - }, - '/docs/server-configuration', - '/docs/server-side-repo-config', - '/docs/pre-workflow-hooks', - '/docs/post-workflow-hooks', - '/docs/policy-checking', - '/docs/custom-workflows', - '/docs/repo-level-atlantis-yaml', - '/docs/upgrading-atlantis-yaml', - '/docs/command-requirements', - '/docs/checkout-strategy', - '/docs/terraform-versions', - '/docs/terraform-cloud', - '/docs/using-slack-hooks', - '/docs/stats', - '/docs/faq', - ] - }, - { - text: 'Using Atlantis', - collapsible: true, - children: [ - { - text: 'Overview', - link: '/docs/using-atlantis', - }, - '/docs/api-endpoints', - ] - }, - { - text: 'How Atlantis Works', - collapsible: true, - children: [ - { - text: 'Overview', - link: '/docs/how-atlantis-works', - }, - '/docs/locking', - '/docs/autoplanning', - '/docs/automerging', - '/docs/security', - ] - }, - { - text: 'Real-time Terraform Logs', - collapsible: true, - children: [ - '/docs/streaming-logs', - ] - }, - { - text: 'Troubleshooting', - collapsible: true, - children: [ - '/docs/troubleshooting-https', - ] - } - ], - '/contributing/': [ - { - text: 'Implementation Details', - children: [ - '/contributing/events-controller', - ] - }, - '/contributing/glossary', - ], - }, + sidebar: sidebar.en, repo: 'runatlantis/atlantis', docsDir: 'runatlantis.io', editLink: true, diff --git a/runatlantis.io/.vuepress/navbar.js b/runatlantis.io/.vuepress/navbar.js new file mode 100644 index 0000000000..7ec398afba --- /dev/null +++ b/runatlantis.io/.vuepress/navbar.js @@ -0,0 +1,9 @@ +const en = [ + { text: 'Home', link: '/' }, + { text: 'Guide', link: '/guide/' }, + { text: 'Docs', link: '/docs/' }, + { text: "Contributing", link: "/contributing/" }, + { text: 'Blog', link: 'https://medium.com/runatlantis' }, +]; + +export default { en }; diff --git a/runatlantis.io/.vuepress/sidebar.js b/runatlantis.io/.vuepress/sidebar.js new file mode 100644 index 0000000000..67caab55f3 --- /dev/null +++ b/runatlantis.io/.vuepress/sidebar.js @@ -0,0 +1,88 @@ +const en = { + '/guide/': [ + '/guide/', + '/guide/test-drive', + '/guide/testing-locally', + ], + '/docs/': [ + { + text: 'Installing Atlantis', + collapsible: true, + children: [ + '/docs/installation-guide', + '/docs/requirements', + '/docs/access-credentials', + '/docs/webhook-secrets', + '/docs/deployment', + '/docs/configuring-webhooks', + '/docs/provider-credentials', + ] + }, + { + text: 'Configuring Atlantis', + collapsible: true, + children: [ + { + text: 'Overview', + link: '/docs/configuring-atlantis', + }, + '/docs/server-configuration', + '/docs/server-side-repo-config', + '/docs/pre-workflow-hooks', + '/docs/post-workflow-hooks', + '/docs/policy-checking', + '/docs/custom-workflows', + '/docs/repo-level-atlantis-yaml', + '/docs/upgrading-atlantis-yaml', + '/docs/command-requirements', + '/docs/checkout-strategy', + '/docs/terraform-versions', + '/docs/terraform-cloud', + '/docs/using-slack-hooks', + '/docs/stats', + '/docs/faq', + ] + }, + { + text: 'Using Atlantis', + collapsible: true, + children: [ + { + text: 'Overview', + link: '/docs/using-atlantis', + }, + '/docs/api-endpoints', + ] + }, + { + text: 'How Atlantis Works', + collapsible: true, + children: [ + { + text: 'Overview', + link: '/docs/how-atlantis-works', + }, + '/docs/locking', + '/docs/autoplanning', + '/docs/automerging', + '/docs/security', + ] + }, + { + text: 'Real-time Terraform Logs', + collapsible: true, + children: [ + '/docs/streaming-logs', + ] + }, + { + text: 'Troubleshooting', + collapsible: true, + children: [ + '/docs/troubleshooting-https', + ] + } + ] +}; + +export default { en }; diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md index 87892c3dd2..5adc1fc8ac 100644 --- a/runatlantis.io/docs/server-configuration.md +++ b/runatlantis.io/docs/server-configuration.md @@ -385,7 +385,7 @@ and set `--autoplan-modules` to `false`. ```bash atlantis server --disable-markdown-folding # or - ATLANTIS_DISABLE_MARKDOWN_FOLDER=true + ATLANTIS_DISABLE_MARKDOWN_FOLDING=true ``` Disable folding in markdown output using the `
` html tag. diff --git a/runatlantis.io/docs/using-slack-hooks.md b/runatlantis.io/docs/using-slack-hooks.md index 78955a5100..8b32b1b92b 100644 --- a/runatlantis.io/docs/using-slack-hooks.md +++ b/runatlantis.io/docs/using-slack-hooks.md @@ -43,7 +43,7 @@ webhooks: workspace-regex: .* branch-regex: .* kind: slack - channel: my-channel + channel: my-channel-id ``` If you are deploying Atlantis as a Helm chart, this can be implemented via the `config` parameter available for [chart customizations](https://github.com/runatlantis/helm-charts#customization): @@ -59,9 +59,9 @@ config: | workspace-regex: .* branch-regex: .* kind: slack - channel: my-channel + channel: my-channel-id ``` -The `apply` event information will be sent to the `my-channel` Slack channel. +The `apply` event information will be sent to the `my-channel-id` Slack channel.