Skip to content

[repo] Fix image pointers and improve release process #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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: 0 additions & 4 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Auto-detect text files, ensure they use LF.
* text=auto eol=lf working-tree-encoding=UTF-8

# Denote all files that are truly binary and should not be modified.
*.png binary
*.jpg binary

# Bash scripts
*.sh text eol=lf

Expand Down
78 changes: 45 additions & 33 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,47 @@
# Release Process

1. Pull latest changes
1. Run linter
1. install/build
1. run tests.
1. Install cli: cd into cli folder then `npm i -g`
1. Test the cli, run an app.

## Create Changeset

```bash
npx changeset add
```

1. Run `npm i` again - `package-lock.json` updates
1. Update root `package.json` manually

## Apply Changeset

```bash
npx changeset version
```

## Publish Changeset

```bash
npx changeset publish
```

## Push Tags

```bash
git push --tags
```
## Release

1. `npm run ship:pre`
- Runs the pre-release script:
- Verifies you are on the main branch and have no uncommitted changes,
- Pulls the latest changes from origin/main,
- Checks for outdated dependencies,
- Runs lint, clean, install/build, and tests,
- Bumps the version in the root `package.json`
- (default: prerelease, or use `--bump=minor` for a minor version bump).
- You can use `--dry-run` or `-d` to preview the steps without making changes.
1. `cd packages/cli && npm i -g`
- Installs the CLI globally from your local code.
1. `teams --version`
- Verifies the installed CLI version matches the bumped version.
1. Test the CLI
- Create a new temporary app and run it.
- If CLI has been updated, test the new/updated commands.
1. `npm run dev --workspace=@tests/<app>`
- Run an app from the `/tests` folder
- Ensure the development/test apps work as expected.
1. `npx changeset add`
- Select **all** @microsoft/teams/\* packages to include in the changeset. This will create a new changeset file in `.changeset/`.
1. Review the changeset file in `.changeset/`
- Ensure it includes all necessary packages and changes.
1. `npm i`
- Updates `package-lock.json` after the changeset.
1. `npx changeset version`
- Applies the changeset, updating package versions and generating changelogs.
1. `npx changeset publish`
- Publishes to npmjs.org.
1. `npm run ship:tag`
- creates a main tag for all combined packages (`vX.x.x(-preview.X`))

## 🎉 Published! 🎉

## Finalizing the release

1. Make a new PR with changed files; should include:
- New `.changeset/` files
- Root `package.json` and `package-lock.json`
- All updated `package.json` and `CHANGELOG.md` files for each released package
1. Go to the [GitHub Releases page](https://github.com/microsoft/teams.ts/releases) and create a new release using the tag created from running `ship:tag`. Also, use 'from last tag' to ensure the release notes are generated correctly.
1. Verify one or more of the packages on [npmjs.org](https://www.npmjs.com/) that version has been published. Sometimes caching issues may cause a delay.
1. [Optional] Make a new PR running `npm update --workspaces`
Binary file modified assets/architecture.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/consolidate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/episodic_vs_semantic_memory.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/icons/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/icons/icon_filled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/icons/teams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/card_designer_attachment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/card_designer_typescript_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/cli_copilot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/cli_copilot_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/devtools-default-send.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/devtools_blank_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/devtools_message_reaction.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/devtools_uparrow_feature.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/devtools_with_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/feedback_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/feedback_message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/inspect_activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/message-delete-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/message-reaction-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/message-reaction-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/message-update-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/message-update-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/send_activity_with_attachment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshots/send_stream_activity.png
Binary file modified assets/screenshots/streaming.gif
Loading
Loading