-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into cue-spec-validation
- Loading branch information
Showing
100 changed files
with
16,684 additions
and
2,354 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| name: deploy-docs | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - '.github/workflows/deploy-docs.yaml' | ||
| - 'website/**' | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - '.github/workflows/deploy-docs.yaml' | ||
| - 'website/**' | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| deploy: | ||
| name: Generate docs website to GitHub Pages | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| defaults: | ||
| run: | ||
| working-directory: website | ||
| steps: | ||
| - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 | ||
|
|
||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@f086349bfa2bd1361f7909c78558e816508cdc10 | ||
| with: | ||
| disable-sudo: true | ||
| egress-policy: block | ||
| allowed-endpoints: > | ||
| github.com:443 | ||
| registry.yarnpkg.com:443 | ||
| *.githubusercontent.com:443 | ||
| *.blob.core.windows.net:443 | ||
| - name: Setup Node | ||
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | ||
| with: | ||
| node-version: 20.x | ||
|
|
||
| - name: Get yarn cache | ||
| id: yarn-cache | ||
| run: echo "dir=$(yarn cache dir)" > $GITHUB_OUTPUT | ||
|
|
||
| - name: Cache dependencies | ||
| uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | ||
| with: | ||
| path: ${{ steps.yarn-cache.outputs.dir }} | ||
| key: ${{ runner.os }}-website-${{ hashFiles('**/yarn.lock') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-website- | ||
| - run: yarn install --frozen-lockfile | ||
| - run: yarn build | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' && github.repository == 'Azure/dalec' | ||
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./website/build | ||
| destination_dir: ./docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,7 @@ You will need to add a `syntax` directive at the top of your spec file to enable | |
| # syntax=ghcr.io/azure/dalec/frontend:latest | ||
| ``` | ||
|
|
||
| ### Exmples: | ||
| ### Examples: | ||
|
|
||
| You can look at the [test/fixtures](./test/fixtures) directory for examples of dalec specs. | ||
|
|
||
|
|
@@ -58,13 +58,15 @@ To print a list of available build targets: | |
|
|
||
| ```console | ||
| $ BUILDX_EXPERIMENTAL=1 docker build --print=targets -f test/fixtures/moby-runc.yml . | ||
| debug/gomods Outputs all the gomodule dependencies for the spec | ||
| debug/resolve Outputs the resolved dalec spec file with build args applied. | ||
| mariner2 Alias for target mariner2/container | ||
| mariner2/container (default) Builds a container with the RPM installed. | ||
| debug/sources Outputs all sources from a dalec spec file. | ||
| mariner2/container (default) Builds a container image for mariner2. | ||
| mariner2/container/depsonly Builds a container image with only the runtime dependencies installed. | ||
| mariner2/rpm Builds an rpm and src.rpm for mariner2. | ||
| mariner2/rpm/buildroot Outputs an rpm buildroot suitable for passing to rpmbuild. | ||
| mariner2/rpm/sources Outputs all the sources specified in the spec file. | ||
| mariner2/rpm/spec Outputs the generated RPM spec file | ||
| mariner2/rpm/debug/buildroot Outputs an rpm buildroot suitable for passing to rpmbuild. | ||
| mariner2/rpm/debug/sources Outputs all the sources specified in the spec file in the format given to rpmbuild. | ||
| mariner2/rpm/debug/spec Outputs the generated RPM spec file | ||
| ``` | ||
|
|
||
|
|
||
|
|
@@ -90,10 +92,30 @@ targets: | |
| # ... | ||
| ``` | ||
|
|
||
| ## Docs | ||
|
|
||
| Docs are available at [https://azure.github.io/dalec/](https://azure.github.io/dalec/). | ||
|
|
||
|
|
||
| ### Building the docs | ||
|
|
||
| You can view the docs locally by running: | ||
|
|
||
| ```console | ||
| $ go -C website run . | ||
| ``` | ||
|
|
||
| This will, by default, make the docs available on `http://localhost:3000/dalec/`. | ||
| You can customize the port with `--port <port>`. | ||
|
|
||
| ```console | ||
| $ go -C website run . --port 3001 | ||
| ``` | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. | ||
|
|
||
|
|
@@ -107,8 +129,8 @@ contact [[email protected]](mailto:[email protected]) with any additio | |
|
|
||
| ## Trademarks | ||
|
|
||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft | ||
| trademarks or logos is subject to and must follow | ||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft | ||
| trademarks or logos is subject to and must follow | ||
| [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). | ||
| Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. | ||
| Any use of third-party trademarks or logos are subject to those third-party's policies. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| # Support | ||
|
|
||
| ## How to file issues and get help | ||
| ## How to file issues and get help | ||
|
|
||
| This project uses GitHub Issues to track bugs and feature requests. Please search the existing | ||
| issues before filing new issues to avoid duplicates. For new issues, file your bug or | ||
| This project uses GitHub Issues to track bugs and feature requests. Please search the existing | ||
| issues before filing new issues to avoid duplicates. For new issues, file your bug or | ||
| feature request as a new Issue. | ||
|
|
||
| For help and questions about using this project, please use Github Discussions. | ||
|
|
||
| ## Microsoft Support Policy | ||
| ## Microsoft Support Policy | ||
|
|
||
| Support for this **PROJECT or PRODUCT** is limited to the resources listed above. |
Oops, something went wrong.