From ef47f16ece0346bd93512d446fe1a43c8e7e0722 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Stehl=C3=ADk?= Date: Wed, 22 Nov 2023 11:51:05 +0100 Subject: [PATCH] ci: Improve build pipeline (#5) * ci: Add hadolint * ci: Add hadolint * ci: Add hadolint * ci: Add hadolint * ci: Add hadolint * ci: Add hadolint * ci: Add hadolint * docs: Modify documentation * docs: Modify documentation * docs: Modify documentation * ci: Rename version.env to version * ci: Check if aws cli works on ARM * ci: Check if aws cli works on ARM * ci: test build-args * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Refactor Dockerfile * ci: Remove unnecessary env variable --- .github/CODE_OF_CONDUCT.md | 133 +++++++++++++++++ .github/CONTRIBUTING.md | 29 ++++ .github/PULL_REQUEST_TEMPLATE.md | 21 +++ .github/workflows/docker-pr.yaml | 19 +-- .github/workflows/docker-release.yaml | 26 ++-- Dockerfile-alpine | 2 - Dockerfile-debian | 24 +-- LICENSE | 201 ++++++++++++++++++++++++++ README.md | 63 ++++++-- version | 1 + version.env | 1 - 11 files changed, 476 insertions(+), 44 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 LICENSE create mode 100644 version delete mode 100644 version.env diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..58d3674 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +info@lablabs.io. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..245ac74 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +When contributing to this repository, please first create an issue and link the PR with it. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Modify `Dockerfile` or `version`. `version` contains the base Atlantis version. +2. Create PR, which trigger the docker-pr.yaml workflow. +3. After approvals and testing, PR will be merged and built images and commit automatically tagged + +## Checklists for contributions + +- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits. +- [ ] CI tests are passing +- [ ] README.md has been updated after any changes. The variables and outputs in the README.md has been generated. + +## Semantic Pull Requests + +Pull Requests or Commits must follow conventional specs below: + +- `ci:` Changes to our CI configuration files and scripts (example scopes: GitHub Actions) +- `docs:` Documentation only changes +- `feat:` A new feature +- `fix:` A bug fix +- `refactor:` A code change that neither fixes a bug nor adds a feature +- `style:` Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- `test:` Adding missing tests or correcting existing tests diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f862b60 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +# Description + + + +## Type of change + +- [ ] A bug fix (PR prefix `fix`) +- [ ] A new feature (PR prefix `feat`) +- [ ] A code change that neither fixes a bug nor adds a feature (PR prefix `refactor`) +- [ ] Adding missing tests or correcting existing tests (PR prefix `test`) +- [ ] Changes that do not affect the meaning of the code like white-spaces, formatting, missing semi-colons, etc. (PR prefix `style`) +- [ ] Changes to our CI configuration files and scripts (PR prefix `ci`) +- [ ] Documentation only changes (PR prefix `docs`) + +## How Has This Been Tested? + + diff --git a/.github/workflows/docker-pr.yaml b/.github/workflows/docker-pr.yaml index d323e5d..a5aa759 100644 --- a/.github/workflows/docker-pr.yaml +++ b/.github/workflows/docker-pr.yaml @@ -6,12 +6,7 @@ on: - 'main' paths: - 'Dockerfile*' - - 'version.env' - - '.github/workflows/**' - -env: - DOCKERFILE_TAG: ${{ github.event.pull_request.head.sha }} - DOCKERFILE: Dockerfile-debian + - 'version' jobs: build-image: @@ -25,12 +20,18 @@ jobs: - name: Checkout code uses: actions/checkout@v3 + - name: Lint Dockerfile + id: hadolint + uses: hadolint/hadolint-action@v3.1.0 + with: + dockerfile: "./Dockerfile-${{ matrix.os }}" + failure-threshold: warning + - name: Get Atlantis version id: atlantis-version shell: bash run: | - source ./version.env - echo "ATLANTIS_VERSION=$ATLANTIS_VERSION" >> "$GITHUB_OUTPUT" + echo "ATLANTIS_VERSION=$(cat version)" >> "$GITHUB_OUTPUT" - name: Set up QEMU uses: docker/setup-qemu-action@v2 @@ -67,4 +68,4 @@ jobs: platforms: linux/amd64,linux/arm64 tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} - push: true \ No newline at end of file + push: true diff --git a/.github/workflows/docker-release.yaml b/.github/workflows/docker-release.yaml index aaac941..41bc345 100644 --- a/.github/workflows/docker-release.yaml +++ b/.github/workflows/docker-release.yaml @@ -6,8 +6,7 @@ on: - 'main' paths: - 'Dockerfile*' - - 'version.env' - - '.github/workflows/**' + - 'version' jobs: tag: @@ -24,33 +23,37 @@ jobs: id: atlantis-version shell: bash run: | - source ./version.env - echo "ATLANTIS_VERSION=$ATLANTIS_VERSION" >> "$GITHUB_OUTPUT" + echo "ATLANTIS_VERSION=$(cat version)" >> "$GITHUB_OUTPUT" - name: Construct tag id: tag shell: bash run: | latest_version_tag=$(git describe --tags --match="${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v*" --abbrev=0 --always HEAD) - - if [[ $latest_version_tag =~ ^${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v* ]]; then + + if [[ $latest_version_tag =~ ^${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v* ]]; then echo "A tag $latest_version_tag exists for this Atlantis version. Incrementing..." old_suffix=$(echo $latest_version_tag | sed "s/${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v//g") new_suffix=$(($old_suffix+1)) tag="${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v$new_suffix" - else + else echo "No tag exists for this Atlantis version. Creating new v1 tag..." tag="${{ steps.atlantis-version.outputs.ATLANTIS_VERSION }}-v1" fi - - echo "New tag: $tag" + + echo "New tag: $tag" echo "TAG=$tag" >> "$GITHUB_OUTPUT" - - name: Create push tag + - name: Push tag run: | git tag ${{ steps.tag.outputs.TAG }} git push origin ${{ steps.tag.outputs.TAG }} + - name: Create GitHub release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh release create ${{ steps.tag.outputs.TAG }} --generate-notes --draft + build-image: needs: tag runs-on: ubuntu-22.04 @@ -67,8 +70,7 @@ jobs: id: atlantis-version shell: bash run: | - source ./version.env - echo "ATLANTIS_VERSION=$ATLANTIS_VERSION" >> "$GITHUB_OUTPUT" + echo "ATLANTIS_VERSION=$(cat version)" >> "$GITHUB_OUTPUT" - name: Set up QEMU uses: docker/setup-qemu-action@v2 diff --git a/Dockerfile-alpine b/Dockerfile-alpine index f4515d5..0ceca6d 100644 --- a/Dockerfile-alpine +++ b/Dockerfile-alpine @@ -32,5 +32,3 @@ COPY --from=builder /aws-cli-bin/ /usr/local/bin/ # Install Infracost ARG INFRACOST_VERSION=v0.10.22 RUN curl -fsSL https://raw.githubusercontent.com/infracost/infracost/$INFRACOST_VERSION/scripts/install.sh | sh - - diff --git a/Dockerfile-debian b/Dockerfile-debian index 9744f9a..f55667c 100644 --- a/Dockerfile-debian +++ b/Dockerfile-debian @@ -1,17 +1,19 @@ ARG ATLANTIS_VERSION -FROM ghcr.io/runatlantis/atlantis:${ATLANTIS_VERSION}-debian -ARG AWS_CLI_VERSION=2.11.19 -ARG INFRACOST_VERSION=v0.10.22 - -# Install AWS CLI -RUN apt install unzip -RUN curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64-$AWS_CLI_VERSION.zip" -o "awscliv2.zip" -RUN unzip awscliv2.zip -RUN ./aws/install +# Download AWS CLI +FROM curlimages/curl:8.1.1 as awscli +ARG AWSCLI_VERSION=2.11.19 +RUN curl -sSL "https://awscli.amazonaws.com/awscli-exe-linux-$(arch)-${AWSCLI_VERSION}.zip" -o "/tmp/awscli.zip" && \ + unzip /tmp/awscli.zip -d /tmp -RUN rm awscliv2.zip -RUN rm -rf ./aws +FROM ghcr.io/runatlantis/atlantis:${ATLANTIS_VERSION}-debian +COPY --from=awscli /tmp/aws /tmp/aws +RUN /tmp/aws/install \ + && rm -rf /tmp/aws \ + && aws --version # Install Infracost +ARG INFRACOST_VERSION=v0.10.22 +# hadolint ignore=DL4006 RUN curl -fsSL https://raw.githubusercontent.com/infracost/infracost/$INFRACOST_VERSION/scripts/install.sh | sh +RUN infracost --version diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9e712fa --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2022] [Labyrinth Labs] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 98d5045..6136e75 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,68 @@ # docker-atlantis +[](https://lablabs.io/) + +We help companies build, run, deploy and scale software and infrastructure by embracing the right technologies and principles. Check out our website at + +--- + +## Description Custom [Atlantis](https://github.com/runatlantis/atlantis) Docker image repository. -This repository maintains a custom Atlantis Docker image. Extra functionality: - AWS CLI - Infracost -Only **debian** is automatically built for now (alpine takes too long to build). +Only **debian** image is automatically built for now (**alpine** ARM build is failing). -## How to -1. Modify `Dockerfile` or `version.env`. `version.env` contains the base Atlantis version. -2. Create PR, which trigger the docker-pr.yaml workflow. -3. After approvals and testing, PR will be merged and built images and commit automatically tagged +## How to install +Deploy Atlantis according to the official guide https://www.runatlantis.io/docs/deployment.html. + +Available custom Atlantis Docker images are located here https://github.com/lablabs/docker-atlantis/pkgs/container/atlantis. +- Latest release debian image for specific Atlantis version: +```shell +ghcr.io/lablabs/atlantis:<$atlantis-version>-latest-debian +``` +- Specific released debian version: +```shell +ghcr.io/lablabs/atlantis:<$atlantis-version>-v<$release-version>-debian +``` ## Tagging strategy - PR - `<$atlantis-version>-pr<$PR-number>-alpha-<$os>`, e.g. `v0.24.1-pr2-alpha-debian` - `<$atlantis-version>-<$commit-sha>-<$os>`, e.g. `v0.24.1-23523572395472943572934552452352-debian` - main - - `-latest-<$os>`, e.g. `v0.24.1-latest-debian` - - `<$atlantis-version>-v<$single-number-version>-<$os>`, e.g. `v0.24.1-v2-debian` - - `<$single-number-version>` is incremented +1 with each non-Atlantis version change to the Dockerfile + - `<$atlantis-version>-latest-<$os>`, e.g. `v0.24.1-latest-debian` + - `<$atlantis-version>-v<$release-version>-<$os>`, e.g. `v0.24.1-v2-debian` + - `<$release-version>` is incremented +1 with each non-Atlantis version change to the Dockerfile + +## How to update +1. Modify `version` if you want to try a new Atlantis version +2. Make other changes you want +3. Create a PR. + +## Contributing +Check [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md) for guideline on how to contribute. + +## License + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +See [LICENSE](LICENSE) for full details. + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. diff --git a/version b/version new file mode 100644 index 0000000..6205e5b --- /dev/null +++ b/version @@ -0,0 +1 @@ +v0.24.2 diff --git a/version.env b/version.env deleted file mode 100644 index 3253417..0000000 --- a/version.env +++ /dev/null @@ -1 +0,0 @@ -ATLANTIS_VERSION=v0.24.2