diff --git a/README.md b/README.md index c3ee852..0322d52 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,32 @@ -# Determinate Nix Action +
+ + +# ️❄️ Determinate Nix Action Determinate is the best way to use Nix on macOS, WSL, and Linux. It is an end-to-end toolchain for using Nix, from installation to collaboration to deployment. Based on the [Determinate Nix Installer](https://github.com/DeterminateSystems/nix-installer) and its corresponding [Nix Installer Action](https://github.com/DeterminateSystems/nix-installer-action), responsible for over tens of thousands of Nix installs daily. -## Supports +## 🫶 Platform support -- ✅ **Accelerated KVM** on open source projects and larger runners. See [GitHub's announcement](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/) for more info. -- ✅ Linux, x86_64, aarch64, and i686 -- ✅ macOS, x86_64 and aarch64 -- ✅ WSL2, x86_64 and aarch64 -- ✅ Containers, ARC, and Act -- ✅ GitHub Enterprise Server -- ✅ GitHub Hosted, self-hosted, and long running Actions Runners +- ⚡ **Accelerated KVM** on open source projects and larger runners. See [GitHub's announcement](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/) for more info. +- 🐧 Linux, x86_64, aarch64, and i686 +- 🍏 macOS, x86_64 and aarch64 +- 🪟 WSL2, x86_64 and aarch64 +- 🐋 Containers, ARC, and Act +- 🐙 GitHub Enterprise Server +- 💁 GitHub Hosted, self-hosted, and long running Actions Runners -## Usage +## ️🔧 Usage ```yaml on: @@ -36,22 +47,28 @@ jobs: - run: nix build . ``` -## Pinning +## 📌 Version Pinning: Lock It Down! -This action is tagged automatically for every Determinate Nix release. -Pinning to `DeterminateSystems/determinate-nix-action@v3.5.1` will always resolve to the same `DeterminateSystems/nix-installer-action` revision and will always install Determinate Nix v3.5.1. +### Why Pin Your Action? -This is different from `DeterminateSystems/nix-installer-action`, which does not support explicit pinning. +Unlike `DeterminateSystems/nix-installer-action`, we fully support explicit version pinning for maximum consistency. +This action is **automatically tagged** for every Determinate Nix release, giving you complete control over your CI environment: -If your action does not pin to a specific tag and uses `DeterminateSystems/determinate-nix-action@main` your workflows will follow the latest Determinate Nix release, and occasionally participate in phased Determinate Nix releases. +📍 Pinning to `DeterminateSystems/determinate-nix-action@v3.5.1` guarantees: + - Same `nix-installer-action` revision every time + - Consistent Determinate Nix v3.5.1 installation + - Reproducible CI workflows, even years later + +✨ Using `@main` instead? You'll: + - Always get the latest Determinate Nix release + - Occasionally participate in phased rollouts (helping us test new releases!) > [!IMPORTANT] -> Make sure to setup Dependabot to stay up to date with Determinate Nix releases. +> Set up Dependabot to stay current with Determinate Nix releases without sacrificing stability. -### Setting up Dependabot +### 🤖 Automate Updates with Dependabot -Automatically keep your GitHub actions up to date with Dependabot. -Create a file in your repository at `.github/dependabot.yml` with the following contents: +Keep your GitHub actions fresh without manual work! Create `.github/dependabot.yml` with: ```yaml version: 2 @@ -62,7 +79,7 @@ updates: interval: "weekly" ``` -## Configuration +## ️⚙️ Configuration | Parameter | Description | Required | Default | |-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------| @@ -88,10 +105,12 @@ updates: | `logger` | The logger to use for install (eg. `pretty`, `json`, `full`, `compact`) | | | | `_internal-strict-mode` | Whether to fail when any errors are thrown. Used only to test the Action; do not set this in your own workflows. | | `False` | -## Need help? +## 🛟 Need Help? We're Here For You! -- Open an issue, -- Join our Discord: https://determinate.systems/discord, -- Contact us over email: [support@determinate.systems](mailto:support@determinate.systems), +We're committed to making your experience with Determinate Nix as smooth as possible. If you encounter any issues or have questions, here's how to reach us: -Support contracts and shared slack rooms are available. +- 🐛 **Found a bug?** [Open an issue](https://github.com/DeterminateSystems/determinate-nix-action/issues/new) on GitHub +- 💬 **Want to chat?** Join our [Discord community](https://determinate.systems/discord) for quick help and discussions +- 📧 **Need direct support?** Email us at [support@determinate.systems](mailto:support@determinate.systems) + +🤝 **Looking for enterprise support?** We offer dedicated support contracts and shared Slack channels for organizations requiring priority assistance. [Contact us](mailto:support@determinate.systems) to learn more. \ No newline at end of file diff --git a/tools/README.template.md b/tools/README.template.md index 10e94d6..5c1cf9b 100644 --- a/tools/README.template.md +++ b/tools/README.template.md @@ -1,21 +1,32 @@ -# Determinate Nix Action + + + +# ️❄️ Determinate Nix Action Determinate is the best way to use Nix on macOS, WSL, and Linux. It is an end-to-end toolchain for using Nix, from installation to collaboration to deployment. Based on the [Determinate Nix Installer](https://github.com/DeterminateSystems/nix-installer) and its corresponding [Nix Installer Action](https://github.com/DeterminateSystems/nix-installer-action), responsible for over tens of thousands of Nix installs daily. -## Supports +## 🫶 Platform support -- ✅ **Accelerated KVM** on open source projects and larger runners. See [GitHub's announcement](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/) for more info. -- ✅ Linux, x86_64, aarch64, and i686 -- ✅ macOS, x86_64 and aarch64 -- ✅ WSL2, x86_64 and aarch64 -- ✅ Containers, ARC, and Act -- ✅ GitHub Enterprise Server -- ✅ GitHub Hosted, self-hosted, and long running Actions Runners +- ⚡ **Accelerated KVM** on open source projects and larger runners. See [GitHub's announcement](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/) for more info. +- 🐧 Linux, x86_64, aarch64, and i686 +- 🍏 macOS, x86_64 and aarch64 +- 🪟 WSL2, x86_64 and aarch64 +- 🐋 Containers, ARC, and Act +- 🐙 GitHub Enterprise Server +- 💁 GitHub Hosted, self-hosted, and long running Actions Runners -## Usage +## ️🔧 Usage ```yaml on: @@ -36,22 +47,28 @@ jobs: - run: nix build . ``` -## Pinning +## 📌 Version Pinning: Lock It Down! -This action is tagged automatically for every Determinate Nix release. -Pinning to `DeterminateSystems/determinate-nix-action@` will always resolve to the same `DeterminateSystems/nix-installer-action` revision and will always install Determinate Nix . +### Why Pin Your Action? -This is different from `DeterminateSystems/nix-installer-action`, which does not support explicit pinning. +Unlike `DeterminateSystems/nix-installer-action`, we fully support explicit version pinning for maximum consistency. +This action is **automatically tagged** for every Determinate Nix release, giving you complete control over your CI environment: -If your action does not pin to a specific tag and uses `DeterminateSystems/determinate-nix-action@main` your workflows will follow the latest Determinate Nix release, and occasionally participate in phased Determinate Nix releases. +📍 Pinning to `DeterminateSystems/determinate-nix-action@` guarantees: + - Same `nix-installer-action` revision every time + - Consistent Determinate Nix installation + - Reproducible CI workflows, even years later + +✨ Using `@main` instead? You'll: + - Always get the latest Determinate Nix release + - Occasionally participate in phased rollouts (helping us test new releases!) > [!IMPORTANT] -> Make sure to setup Dependabot to stay up to date with Determinate Nix releases. +> Set up Dependabot to stay current with Determinate Nix releases without sacrificing stability. -### Setting up Dependabot +### 🤖 Automate Updates with Dependabot -Automatically keep your GitHub actions up to date with Dependabot. -Create a file in your repository at `.github/dependabot.yml` with the following contents: +Keep your GitHub actions fresh without manual work! Create `.github/dependabot.yml` with: ```yaml version: 2 @@ -62,14 +79,16 @@ updates: interval: "weekly" ``` -## Configuration +## ️⚙️ Configuration -## Need help? +## 🛟 Need Help? We're Here For You! -- Open an issue, -- Join our Discord: https://determinate.systems/discord, -- Contact us over email: [support@determinate.systems](mailto:support@determinate.systems), +We're committed to making your experience with Determinate Nix as smooth as possible. If you encounter any issues or have questions, here's how to reach us: -Support contracts and shared slack rooms are available. +- 🐛 **Found a bug?** [Open an issue](https://github.com/DeterminateSystems/determinate-nix-action/issues/new) on GitHub +- 💬 **Want to chat?** Join our [Discord community](https://determinate.systems/discord) for quick help and discussions +- 📧 **Need direct support?** Email us at [support@determinate.systems](mailto:support@determinate.systems) + +🤝 **Looking for enterprise support?** We offer dedicated support contracts and shared Slack channels for organizations requiring priority assistance. [Contact us](mailto:support@determinate.systems) to learn more. \ No newline at end of file