Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* @dfinity/sdk

# the following files are auto-approved by github actions, therefore we remove codeowners
/public/core/*
# The following files are maintained by GitHub actions, therefore we remove codeowners.
/public/*
34 changes: 16 additions & 18 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@ summary of what you need to do:
### Install dependencies

1. Install [Deno](https://docs.deno.com/runtime/#quick-install).
```bash
curl -fsSL "https://deno.land/install.sh" | sh
```
2. Install Deno dependencies:
```bash
deno i
Expand Down Expand Up @@ -128,18 +125,19 @@ summary of what you need to do:

## Adding a new sub-site

To add a new sub-site to the documentation, follow these steps:

1. Remove the target directory from codeowners by adding the following to the
`.github/CODEOWNERS` file:
```text
# the following files are auto-approved by github actions, therefore we remove codeowners
/public/core/*
# other entries...
/public/$YOUR_PROJECT_NAME/*
```
2. Add `$YOUR_PROJECT_NAME` to the list of projects in the
`scripts/predeploy.ts` file:
```typescript
const PROJECTS = ["core", "other entries...", "$YOUR_PROJECT_NAME"];
```
To add a new sub-site to the documentation, add `$YOUR_PROJECT_NAME` to the list
of projects in the [`projects.json`](../projects.json) file:

```json
[
{
"repository": "dfinity/agent-js",
"subdirectory": "core"
},
// other entries...
{
"repository": "$YOUR_GITHUB_ORGANIZATION/$YOUR_PROJECT_NAME",
"subdirectory": "$YOUR_PROJECT_NAME"
}
]
```
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Provide additional contextual information about the code changes below this line, then remove this line. -->

<!-- If relevant, provide additional information about breaking changes after the `BREAKING CHANGE` prefix on the following line, then remove this line. Remove the following line if there are no breaking changes. -->

<!--
BREAKING CHANGE:
-->

<!-- If relevant, add a reference to an issue on the following line, then remove this line. Remove the following line if there are no relevant issues. -->

<!--
Ref: #<issue number>
-->
7 changes: 7 additions & 0 deletions .github/repo_policies/BOT_APPROVED_FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# List of approved files that can be changed by a bot via an automated PR.
# This is to increase security and prevent accidentally updating files that shouldn't be changed by a bot.

cz.json
CHANGELOG.md

public/*
8 changes: 2 additions & 6 deletions .github/workflows/check-style.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Deno
uses: denoland/setup-deno@e95548e56dfa95d4e1a28d6f422fafe75c4c26fb # v2.0.3
with:
deno-version: v2.x
uses: dfinity/ci-tools/actions/setup-deno@main
Comment thread
nathanosdev marked this conversation as resolved.

- name: Check Linting
run: deno lint
Expand All @@ -32,9 +30,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Deno
uses: denoland/setup-deno@e95548e56dfa95d4e1a28d6f422fafe75c4c26fb # v2.0.3
with:
deno-version: v2.x
uses: dfinity/ci-tools/actions/setup-deno@main
Comment thread
nathanosdev marked this conversation as resolved.

- name: Check Formatting
run: deno fmt --check
6 changes: 4 additions & 2 deletions .github/workflows/commitizen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ on:
merge_group:
pull_request:

concurrency:
group: pr-${{ github.workflow }}-${{ github.head_ref }}
cancel-in-progress: true

jobs:
check_pr_title:
name: check_pr_title
if: github.event_name == 'pull_request'
uses: dfinity/ci-tools/.github/workflows/check-pr-title.yaml@main

check_commit_messages:
name: check_commit_messages
if: github.event_name == 'merge_group'
uses: dfinity/ci-tools/.github/workflows/check-commit-messages.yaml@main

Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/generate-changelog.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
name: generate_changelog
name: Generate Changelog

on:
push:
branches:
- main

concurrency:
group: main-${{ github.workflow }}
cancel-in-progress: true

jobs:
generate_changelog:
uses: dfinity/ci-tools/.github/workflows/generate-changelog.yaml@main
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pull-project-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

5 changes: 1 addition & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ concurrency:

jobs:
release:
name: Release
runs-on: ubuntu-latest
environment:
name: production
Expand All @@ -21,9 +20,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Deno
uses: denoland/setup-deno@e95548e56dfa95d4e1a28d6f422fafe75c4c26fb # v2.0.3
with:
deno-version: v2.x
uses: dfinity/ci-tools/actions/setup-deno@main
Comment thread
nathanosdev marked this conversation as resolved.

- name: Install dependencies
run: deno i
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@
"deno.codeLens.testArgs": ["--allow-all"],
"[github-actions-workflow]": {
"editor.defaultFormatter": "denoland.vscode-deno"
}
},
"json.schemaDownload.enable": true
}
1 change: 0 additions & 1 deletion deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
"@std/fs": "jsr:@std/fs@^1.0.19",
"@std/path": "jsr:@std/path@^1.0.19",
"@types/yauzl": "npm:@types/yauzl@^2.10.3",
"typescript": "npm:typescript@^5.9.2",
"yauzl": "npm:yauzl@^3.2.0"
}
}
Loading