├── .github ├── CODEOWNERS ├── dependabot.yml ├── pull.yml └── workflows │ └── build.yml ├── .gitignore ├── Containerfile ├── LICENSE ├── README.md ├── cosign.pub └── wizard.sh /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @EinoHR -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "github-actions" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "weekly" 12 | -------------------------------------------------------------------------------- /.github/pull.yml: -------------------------------------------------------------------------------- 1 | version: "1" 2 | rules: 3 | - base: main 4 | upstream: KyleGospo:main 5 | mergeMethod: merge 6 | mergeUnstable: false 7 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build-ublue 2 | on: 3 | pull_request: 4 | branches: 5 | - main 6 | push: 7 | branches: 8 | - main 9 | env: 10 | IMAGE_NAME: create-ublue-image 11 | IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }} 12 | 13 | jobs: 14 | push-ghcr: 15 | name: Build and push image 16 | runs-on: ubuntu-22.04 17 | permissions: 18 | contents: read 19 | packages: write 20 | id-token: write 21 | strategy: 22 | fail-fast: false 23 | matrix: 24 | include: 25 | - is_latest: true 26 | is_stable: true 27 | steps: 28 | # Checkout push-to-registry action GitHub repository 29 | - name: Checkout Push to Registry action 30 | uses: actions/checkout@v4 31 | 32 | # Build metadata 33 | - name: Image Metadata 34 | uses: docker/metadata-action@v5 35 | id: meta 36 | with: 37 | images: | 38 | ${{ env.IMAGE_NAME }} 39 | 40 | - name: Generate tags 41 | id: generate-tags 42 | shell: bash 43 | run: | 44 | echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT 45 | alias_tags=() 46 | # Only perform the follow code when the action is spawned from a Pull Request 47 | if [[ "${{ github.event_name }}" == "pull_request" ]]; then 48 | alias_tags+=("pr-${{ github.event.number }}") 49 | else 50 | # The following is run when the timer is triggered or a merge/push to main 51 | echo "date=$(date +%Y%m%d)" >> $GITHUB_OUTPUT 52 | if [[ "${{ matrix.is_latest }}" == "true" ]]; then 53 | alias_tags+=("latest") 54 | fi 55 | if [[ "${{ matrix.is_stable }}" == "true" ]]; then 56 | alias_tags+=("stable") 57 | fi 58 | fi 59 | echo "alias_tags=${alias_tags[*]}" >> $GITHUB_OUTPUT 60 | 61 | # Build image using Buildah action 62 | - name: Build Image 63 | id: build_image 64 | uses: redhat-actions/buildah-build@v2 65 | with: 66 | containerfiles: | 67 | ./Containerfile 68 | image: ${{ env.IMAGE_NAME }} 69 | tags: | 70 | ${{ steps.generate-tags.outputs.alias_tags }} 71 | ${{ steps.generate-tags.outputs.date }} 72 | ${{ steps.generate-tags.outputs.sha_short }} 73 | labels: ${{ steps.meta.outputs.labels }} 74 | oci: false 75 | 76 | # Workaround bug where capital letters in your GitHub username make it impossible to push to GHCR. 77 | # https://github.com/macbre/push-to-ghcr/issues/12 78 | - name: Lowercase Registry 79 | id: registry_case 80 | uses: ASzc/change-string-case-action@v6 81 | with: 82 | string: ${{ env.IMAGE_REGISTRY }} 83 | 84 | # Push the image to GHCR (Image Registry) 85 | - name: Push To GHCR 86 | uses: redhat-actions/push-to-registry@v2 87 | id: push 88 | if: github.event_name != 'pull_request' 89 | env: 90 | REGISTRY_USER: ${{ github.actor }} 91 | REGISTRY_PASSWORD: ${{ github.token }} 92 | with: 93 | image: ${{ steps.build_image.outputs.image }} 94 | tags: ${{ steps.build_image.outputs.tags }} 95 | registry: ${{ steps.registry_case.outputs.lowercase }} 96 | username: ${{ env.REGISTRY_USER }} 97 | password: ${{ env.REGISTRY_PASSWORD }} 98 | extra-args: | 99 | --disable-content-trust 100 | - name: Login to GitHub Container Registry 101 | uses: docker/login-action@v3 102 | if: github.event_name != 'pull_request' 103 | with: 104 | registry: ghcr.io 105 | username: ${{ github.actor }} 106 | password: ${{ secrets.GITHUB_TOKEN }} 107 | 108 | # Sign container 109 | - uses: sigstore/cosign-installer@v3.5.0 110 | if: github.event_name != 'pull_request' 111 | 112 | - name: Sign container image 113 | if: github.event_name != 'pull_request' 114 | run: | 115 | echo "${{ env.COSIGN_PRIVATE_KEY }}" > cosign.key 116 | wc -c cosign.key 117 | cosign sign -y --key cosign.key ${{ steps.registry_case.outputs.lowercase }}/${{ env.IMAGE_NAME }}@${TAGS} 118 | env: 119 | TAGS: ${{ steps.push.outputs.digest }} 120 | COSIGN_EXPERIMENTAL: false 121 | COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }} 122 | 123 | - name: Echo outputs 124 | if: github.event_name != 'pull_request' 125 | run: | 126 | echo "${{ toJSON(steps.push.outputs) }}" 127 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | cosign.key 2 | -------------------------------------------------------------------------------- /Containerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:edge 2 | 3 | COPY wizard.sh /usr/bin/wizard.sh 4 | 5 | RUN chmod +x /usr/bin/wizard.sh 6 | RUN apk update 7 | RUN apk add git openssh gum github-cli jq yq cosign 8 | 9 | ENTRYPOINT ["/usr/bin/wizard.sh"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # create-ublue-image 2 | 3 | This is a small containerized tool to automatically create a functional Github repository custom ostree native container image based on [blue-build/template](https://github.com/blue-build/template). 4 | 5 | I'm working on a web-based version at [ublue-os/images-website](https://github.com/ublue-os/images-website), but this one will also be maintained for the time being. 6 | 7 | ## Running 8 | 9 | ***create-ublue-image*** should run on any computer with [Podman](https://podman.io/) installed. If you are already running an immutable Fedora variant, you shouldn't have to install anything. 10 | 11 | Run the following command in a directory that you have write access to, your repo will be created as a subdirectory. The script will ask you further questions. 12 | 13 | ``` 14 | podman run -v "$(pwd)":/host --security-opt label=disable -it --pull=newer ghcr.io/xynydev/create-ublue-image 15 | ``` 16 | **It is not recommended to run the tool inside your home directory, but rather a subdirectory, as that can cause errors.** 17 | 18 | However, if the command tool starts in your home dir without any errors, it should probably function. 19 | You do not need to run the tool in an empty directory, it will create a new one with the name that you input. 20 | 21 | This command runs the OCI container built in this repo using `podman` mounting your working directory `pwd` into the container under the path `/host`. `:z` makes it possible for multiple containers to use the volume at the same time, which is useful when running a Distrobox. If you run into issues with "relabeling" when running the command, you should try removing `:z` from the end of the mount command. 22 | 23 | ## Pull latest commits 24 | 25 | In order to update changes from the upstream repository, run: 26 | 27 | ``` 28 | git fetch upstream 29 | git merge upstream/main -m "chore: merging upstream changes" 30 | ``` 31 | 32 | Some instructions also exist in the uBlue docs: https://ublue.it/making-your-own/#automatic-setup 33 | 34 | ## Can I trust you? 35 | 36 | This tool uses `github-cli` to authenticate to your account, which could be a security concern. 37 | You can read all of the code in `wizard.sh` (<100 loc) and see for yourself everything this tool does. 38 | You can also just set up the repository manually. 39 | -------------------------------------------------------------------------------- /cosign.pub: -------------------------------------------------------------------------------- 1 | -----BEGIN PUBLIC KEY----- 2 | MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEKWpsgyFOQFCmKLBOH9eCHGjuXB2l 3 | pOBCO+EhvXGMqpZ35aUsrwW90WE2+QC3rPsz3TbxuonpGzPyAh9i0ousOQ== 4 | -----END PUBLIC KEY----- 5 | -------------------------------------------------------------------------------- /wizard.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | README_PATH="./README.md" 4 | RECIPE_PATH="config/recipe.yml" 5 | 6 | trap "exit" INT HUP TERM 7 | 8 | gum format -- "# --- Welcome to the uBlue image creation wizard! --- " 9 | 10 | cd /host || { echo "Expected /host mount to be present" ; exit 1; } 11 | 12 | gum format -- "To get started, please log in to Github. This is used to set up the repository, **nothing will be deleted or modified, only added!** You can read the source code of this script in [the repo](https://github.com/xynydev/create-ublue-image/)." 13 | echo 14 | gh auth login -p https -w -s workflow 15 | GIT_USER=$(gh api /user | jq '.login' -r) 16 | 17 | echo 18 | gum format -- "## Please input a name for the directory you want to clone your custom image repository to." "A directory with this name will be created inside your working directory." 19 | echo 20 | REPO_DIR=$(gum input --placeholder "ie. my-ublue") 21 | gh repo clone blue-build/template "$REPO_DIR" 22 | 23 | cd "$REPO_DIR" || exit 24 | git remote rm upstream 25 | git remote rename origin upstream 26 | 27 | echo 28 | gum format -- "## Please input a name for the public repository on Github for your custom image." "A repository and package with this name will be created using your github account." 29 | echo 30 | REPO_NAME=$(gum input --placeholder "ie. my-ublue, org-name/silverblue-for-cats") 31 | gh repo create "$REPO_NAME" --source . --push --public 32 | case "$REPO_NAME" in 33 | */*) 34 | REPO_FULL_NAME="$REPO_NAME" 35 | gh repo set-default "$REPO_FULL_NAME" 36 | ;; 37 | *) 38 | REPO_FULL_NAME="$GIT_USER"/"$REPO_NAME" 39 | gh repo set-default "$REPO_FULL_NAME" 40 | ;; 41 | esac 42 | 43 | echo "Setting up git for changes..." 44 | git config user.name "$GIT_USER" 45 | git config user.email "$GIT_USER"@users.noreply.github.com 46 | 47 | echo "Enabling container signing..." 48 | echo 49 | gum format -- "**Please do not input a password when prompted,** instead just press enter. The container signing wont work in Github CI if you have an encrypted signing key." 50 | echo 51 | cosign generate-key-pair 52 | gh secret set SIGNING_SECRET -R "$REPO_FULL_NAME" < cosign.key 53 | git add cosign.pub && git commit -m "chore(automatic): add public key" 54 | 55 | echo "Renaming your image from \"template\" to $REPO_NAME..." 56 | 57 | # Set the image name in recipe.yml 58 | LOWERCASE_NAME=$(echo "$REPO_NAME" | tr '[:upper:]' '[:lower:]') 59 | yq -i ".name = \"$LOWERCASE_NAME\"" "${RECIPE_PATH}" 60 | git add "${RECIPE_PATH}" 61 | git commit -m "chore(automatic): change image name" 62 | 63 | # The repo full name has to be escaped for use with sed and lowercased for GHCR compatibility 64 | ESCAPED_REPO_FULL_NAME=$(echo "$REPO_FULL_NAME" | sed "s;\/;\\\/;" | tr '[:upper:]' '[:lower:]') 65 | sed -i "s/blue-build\/template/$ESCAPED_REPO_FULL_NAME/g" ./README.md 66 | git add README.md 67 | git commit -m "chore(automatic): update all repo/image links" 68 | 69 | sed -i "s/^# .*/# $REPO_NAME/" "${README_PATH}" 70 | git add "${README_PATH}" 71 | git commit -m "chore(automatic): update main title" 72 | 73 | gum format -- "# All done!" \ 74 | "[Your new Github repository](https://github.com/$REPO_FULL_NAME/). A build has been kicked off and an image will be available soon. After that, a new image will be built nightly." \ 75 | "If the build does not start automatically, you can go run it manually [here](https://github.com/$REPO_FULL_NAME/actions/workflows/build.yml)" 76 | --------------------------------------------------------------------------------