Skip to content

Commit

Permalink
fix: format more essentials
Browse files Browse the repository at this point in the history
  • Loading branch information
@EnokiUN
EnokiUN committed Mar 19, 2024
1 parent 72b5245 commit 228d1da
Show file tree
Hide file tree
Showing 182 changed files with 9,376 additions and 12,010 deletions.
244 changes: 122 additions & 122 deletions CONTRIBUTING.md
View file

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
The MIT License (MIT)

Copyright (c) 2015-2021 Rapptz
Copyright (c) 2021-present Disnake Development

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
The MIT License (MIT)
Copyright (c) 2015-2021 Rapptz
Copyright (c) 2021-present Disnake Development
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
14 changes: 7 additions & 7 deletions MANIFEST.in
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
include README.md
include LICENSE
include disnake/bin/*
include disnake/py.typed
include README.md
include LICENSE
include disnake/bin/*
include disnake/py.typed
include disnake/ext/commands/py.typed
include disnake/ext/tasks/py.typed
global-exclude *.py[cod]
exclude pdm.lock
include disnake/ext/tasks/py.typed
global-exclude *.py[cod]
exclude pdm.lock
232 changes: 116 additions & 116 deletions README.md
View file

Large diffs are not rendered by default.

92 changes: 46 additions & 46 deletions RELEASE.md
View file
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
<!-- SPDX-License-Identifier: MIT -->

# Release Procedure

This document provides general information and steps about the project's release procedure.
If you're reading this, this will likely not be useful to you, unless you have administrator permissions in the repository or want to replicate this setup in your own project :p

The process is largely automated, with manual action only being needed where higher permissions are required.
Note that pre-releases (alpha/beta/rc) don't quite work with the current setup; we don't currently anticipate making pre-releases, but this may still be improved in the future.


## Steps

These steps are mostly equivalent for major/minor (feature) and micro (bugfix) releases.
The branch should be `master` for major/minor releases and e.g. `1.2.x` for micro releases.

1. Run the `Create Release PR` workflow from the GitHub UI (or CLI), specifying the correct branch and new version.
1. Wait until a PR containing the changelog and version bump is created. Update the changelog description and merge the PR.
2. In the CLI, fetch changes and create + push a tag for the newly created commit, which will trigger another workflow.
- [if latest] Also force-push a `stable` tag for the same ref.
3. Update the visibility of old/new versions on https://readthedocs.org.
2. Approve the environment deployment when prompted, which will push the package to PyPI.
1. Update and publish the created GitHub draft release, as well as a Discord announcement. 🎉
3. [if major/minor] Create a `v1.2.x` branch for future backports, and merge the newly created dev version PR.


### Manual Steps

If the automated process above does not work for some reason, here's the abridged version of the manual release process:

1. Update version in `__init__.py`, run `towncrier build`. Commit, push, create + merge PR.
2. Follow steps 1.ii. + 1.iii. like above.
3. Run `python -m build`, attach artifacts to GitHub release.
4. Run `twine check dist/*` + `twine upload dist/*`.
5. Follow steps 2.i. + 3. like above.


## Repository Setup

This automated process requires some initial one-time setup in the repository to work properly:

<!-- SPDX-License-Identifier: MIT -->
# Release Procedure
This document provides general information and steps about the project's release procedure.
If you're reading this, this will likely not be useful to you, unless you have administrator permissions in the repository or want to replicate this setup in your own project :p
The process is largely automated, with manual action only being needed where higher permissions are required.
Note that pre-releases (alpha/beta/rc) don't quite work with the current setup; we don't currently anticipate making pre-releases, but this may still be improved in the future.
## Steps
These steps are mostly equivalent for major/minor (feature) and micro (bugfix) releases.
The branch should be `master` for major/minor releases and e.g. `1.2.x` for micro releases.
1. Run the `Create Release PR` workflow from the GitHub UI (or CLI), specifying the correct branch and new version.
1. Wait until a PR containing the changelog and version bump is created. Update the changelog description and merge the PR.
2. In the CLI, fetch changes and create + push a tag for the newly created commit, which will trigger another workflow.
- [if latest] Also force-push a `stable` tag for the same ref.
3. Update the visibility of old/new versions on https://readthedocs.org.
2. Approve the environment deployment when prompted, which will push the package to PyPI.
1. Update and publish the created GitHub draft release, as well as a Discord announcement. 🎉
3. [if major/minor] Create a `v1.2.x` branch for future backports, and merge the newly created dev version PR.
### Manual Steps
If the automated process above does not work for some reason, here's the abridged version of the manual release process:
1. Update version in `__init__.py`, run `towncrier build`. Commit, push, create + merge PR.
2. Follow steps 1.ii. + 1.iii. like above.
3. Run `python -m build`, attach artifacts to GitHub release.
4. Run `twine check dist/*` + `twine upload dist/*`.
5. Follow steps 2.i. + 3. like above.
## Repository Setup
This automated process requires some initial one-time setup in the repository to work properly:
1. Create a GitHub App ([docs](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)), enable write permissions for `content` and `pull_requests`.
2. Install the app in the repository.
3. Set repository variables `GIT_APP_USER_NAME` and `GIT_APP_USER_EMAIL` accordingly.
4. Set repository secrets `BOT_APP_ID` and `BOT_PRIVATE_KEY`.
5. Create a `release-pypi` environment, add protection rules.
6. Set up trusted publishing on PyPI ([docs](https://docs.pypi.org/trusted-publishers/adding-a-publisher/)).
2. Install the app in the repository.
3. Set repository variables `GIT_APP_USER_NAME` and `GIT_APP_USER_EMAIL` accordingly.
4. Set repository secrets `BOT_APP_ID` and `BOT_PRIVATE_KEY`.
5. Create a `release-pypi` environment, add protection rules.
6. Set up trusted publishing on PyPI ([docs](https://docs.pypi.org/trusted-publishers/adding-a-publisher/)).
2 changes: 1 addition & 1 deletion changelog/1014.feature.rst
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Add ``delete_after`` parameter to :meth:`Interaction.edit_original_response`, :meth:`InteractionResponse.edit_message` and :meth:`InteractionMessage.edit`.
Add ``delete_after`` parameter to :meth:`Interaction.edit_original_response`, :meth:`InteractionResponse.edit_message` and :meth:`InteractionMessage.edit`.
2 changes: 1 addition & 1 deletion changelog/1036.feature.rst
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Make :class:`Interaction` and subtypes accept the bot type as a generic parameter to denote the type returned by the :attr:`~Interaction.bot` and :attr:`~Interaction.client` properties.
Make :class:`Interaction` and subtypes accept the bot type as a generic parameter to denote the type returned by the :attr:`~Interaction.bot` and :attr:`~Interaction.client` properties.
2 changes: 1 addition & 1 deletion changelog/1045.bugfix.rst
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
|commands| Fix incorrect typings of :meth:`InvokableApplicationCommand.add_check <.ext.commands.InvokableApplicationCommand.add_check>`, :meth:`InvokableApplicationCommand.remove_check <.ext.commands.InvokableApplicationCommand.remove_check>`, :meth:`Bot.add_app_command_check <.ext.commands.Bot.add_app_command_check>` and :meth:`Bot.remove_app_command_check <.ext.commands.Bot.remove_app_command_check>`.
|commands| Fix incorrect typings of :meth:`InvokableApplicationCommand.add_check <.ext.commands.InvokableApplicationCommand.add_check>`, :meth:`InvokableApplicationCommand.remove_check <.ext.commands.InvokableApplicationCommand.remove_check>`, :meth:`Bot.add_app_command_check <.ext.commands.Bot.add_app_command_check>` and :meth:`Bot.remove_app_command_check <.ext.commands.Bot.remove_app_command_check>`.
2 changes: 1 addition & 1 deletion changelog/1045.feature.rst
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
|commands| Implement :func:`~disnake.ext.commands.app_check` and :func:`~disnake.ext.commands.app_check_any` decorators.
|commands| Implement :func:`~disnake.ext.commands.app_check` and :func:`~disnake.ext.commands.app_check_any` decorators.
2 changes: 1 addition & 1 deletion changelog/1046.feature.rst
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
|commands| Log errors raised by :meth:`.ext.commands.Cog.cog_unload`.
|commands| Log errors raised by :meth:`.ext.commands.Cog.cog_unload`.
Loading

0 comments on commit 228d1da

Please sign in to comment.