Skip to content
Draft
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
59 changes: 24 additions & 35 deletions .github/maintainers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ of your local `deno-slack-sdk` repo:
{
"imports": {
"deno-slack-sdk/": "../../tools/deno-slack-sdk/src/",
"deno-slack-api/": "jsr:@slack/api@2.9.0/"
"deno-slack-api/": "https://deno.land/x/deno_slack_api@1.5.0/"
}
}
```

#### With remote changes

To test with unreleased changes on a remote repo, commit your intended history
to a remote branch and note the full commit SHA. (e.g.
To test with changes on a remote repo, commit your intended history to a remote
branch and note the full commit SHA. (e.g.
`fc0a0a1f0722e28fecb7782513d045522d7c0d6f`).

Then in your sample app's `import_map.json` file, replace the `deno-slack-sdk`
Expand All @@ -74,7 +74,7 @@ import url with:
{
"imports": {
"deno-slack-sdk/": "https://raw.githubusercontent.com/slackapi/deno-slack-sdk/<commit-SHA-goes-here>/src/",
"deno-slack-api/": "jsr:@slack/api@2.9.0/"
"deno-slack-api/": "https://deno.land/x/deno_slack_api@1.5.0/"
}
}
```
Expand Down Expand Up @@ -109,36 +109,16 @@ resemble the default values.
Releases for this library are automatically generated off of git tags. Before
creating a new release, ensure that everything on the `main` branch since the
last tag is in a releasable state! At a minimum,
[run the tests](#testing-with-deno) and validate that the package meets JSR
publishing requirements by doing a dry run of the publish command:

```zsh
deno task publish:dry-run
```
[run the tests](#testing-with-deno).

To create a new release:

1. Determine the new release version. You can start off by incrementing the
version to reflect a patch (i.e. 1.0.0 -> 1.0.1).
- Review the pull request labels of the changes since the last release (i.e.
`semver:minor`, `semver:patch`, `semver:major`). Tip: Your release version
should be based on the tag of the largest change, so if the changes include
a `semver:minor`, the release version should be upgraded to reflect a
minor.
- Ensure that this version adheres to [semantic versioning][semver]. See
[Versioning](#versioning-and-tags) for correct version format. Version tags
should match the following pattern: `1.0.1` (no `v` preceding the number).
2. Create a new branch from `main` named after the release version (e.g.
`1.0.1`).
3. Bump the `version` field in `deno.jsonc` to the new release version.
4. Open a pull request from the version branch into `main` and get it
approved/merged.
1. `git commit -m 'chore(release): version 1.0.1'`
2. `git push -u origin 1.0.1`
5. Create a new GitHub Release from the
1. Create a new GitHub Release from the
[Releases page](https://github.com/slackapi/deno-slack-sdk/releases) by
clicking the "Draft a new release" button.
6. Input a new version manually into the "Choose a tag" input.
2. Input a new version manually into the "Choose a tag" input. You can start off
by incrementing the version to reflect a patch. (i.e. 1.16.0 -> 1.16.1)

- After you input the new version, click the "Create a new tag: x.x.x on
publish" button. This won't create your tag immediately.
- Auto-generate the release notes by clicking the "Auto-generate release
Expand All @@ -147,14 +127,23 @@ To create a new release:
- Edit the resulting notes to ensure they have decent messaging that are
understandable by non-contributors, but each commit should still have it's
own line.
7. Set the "Target" input to the "main" branch.
8. Name the release title after the version tag.
9. Make any adjustments to generated release notes to make sure they are
- Flip to the preview mode and review the pull request labels of the changes
included in this release (i.e. `semver:minor` `semver:patch`,
`semver:major`). Tip: Your release version should be based on the tag of
the largest change, so if this release includes a `semver:minor`, the
release version in your tag should be upgraded to reflect a minor.
- Ensure that this version adheres to [semantic versioning][semver]. See
[Versioning](#versioning-and-tags) for correct version format. Version tags
should match the following pattern: `1.0.1` (no `v` preceding the number).

3. Set the "Target" input to the "main" branch.
4. Name the release title after the version tag.
5. Make any adjustments to generated release notes to make sure they are
accessible and approachable and that an end-user with little context about
this project could still understand.
10. Publish the release by clicking the "Publish release" button!
11. After a few minutes, the corresponding version will be available on
<https://deno.land/x/deno_slack_sdk> and <https://jsr.io/@slack/sdk>.
6. Publish the release by clicking the "Publish release" button!
7. After a few minutes, the corresponding version will be available on
<https://deno.land/x/deno_slack_sdk>.

## Workflow

Expand Down
18 changes: 0 additions & 18 deletions .github/workflows/publish.yml

This file was deleted.

220 changes: 0 additions & 220 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
36 changes: 16 additions & 20 deletions deno.jsonc
Original file line number Diff line number Diff line change
@@ -1,23 +1,15 @@
{
"$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
"name": "@slack/sdk",
"version": "2.15.2",
"exports": {
".": "./src/mod.ts",
"./mod.ts": "./src/mod.ts",
"./types.ts": "./src/types.ts"
},
"publish": {
"exclude": ["**/*_test.ts", "**/fixtures"],
"fmt": {
"include": [
"src",
"tests",
"docs",
"README.md",
"LICENSE",
"deno.jsonc",
"src/**"
]
},
"fmt": {
"include": ["src", "tests", "docs", "README.md", "scripts", ".github/maintainers_guide.md", ".github/CONTRIBUTING.md"],
"scripts",
".github/maintainers_guide.md",
".github/CONTRIBUTING.md"
],
"exclude": ["src/schema/slack/functions/_scripts/functions.json"],
"semiColons": true,
"indentWidth": 2,
Expand All @@ -28,13 +20,17 @@
},
"lint": {
"include": ["src", "tests", "scripts"],
"exclude": ["src/schema/slack/functions/_scripts/functions.json", "**/*.md"],
"rules": { "exclude": ["no-import-prefix", "no-slow-types"] }
"exclude": [
"src/schema/slack/functions/_scripts/functions.json",
"**/*.md"
],
"rules": {
"exclude": ["no-import-prefix"]
}
},
"tasks": {
"test": "deno fmt --check && deno lint && deno run --allow-run --allow-env --allow-read scripts/bundle.ts && deno test --allow-read --allow-run --parallel src/ tests/",
"coverage": "rm -rf .coverage && deno test --reporter=dot --parallel --allow-read --coverage=.coverage src/ && deno coverage --exclude=fixtures --exclude=_test --lcov --output=lcov.info .coverage",
"publish:dry-run": "deno publish --allow-slow-types --dry-run"
"coverage": "rm -rf .coverage && deno test --reporter=dot --parallel --allow-read --coverage=.coverage src/ && deno coverage --exclude=fixtures --exclude=_test --lcov --output=lcov.info .coverage"
},
"lock": false
}
Loading
Loading