Skip to content

Conversation

@jreineckearm
Copy link
Contributor

@jreineckearm jreineckearm commented Jan 20, 2025

Addresses #136 (see issue for rational why not updating more dependencies first).
Should be merged after #135.

Note that this contains some potentially controversial changes concerning the extension's name.

Preparations for first release to both VS Code marketplace and Open VSX registry.

  • Targets v1.1.0 v2.0.0.
  • Updates version in CHANGELOG.md and package.json.
  • Adds some missing/useful fields to the extension manifest. This includes displayName which is shown on the marketplace and presumably Open VSX instead of cdt-gdb-vscode.
    • Set displayName to "CDT GDB Debug Adapter Extension"
    • Changed description to "CDT GDB debug adapter extension for Visual Studio Code" to better agree with VS Code brand guidelines.
    • Updated README.md, DEVELOPMENT.md, and CONTRIBUTING.md titles (in the files) accordingly.

Adding displayName and changing description and MD title names (in the files) is the potentially controversial part:

  • The extension will show now with a different name in Open VSX. And after installation in VS Code.
  • This could be a reason for a major version change, i.e. to v2.0.0. But I believe removal of the Memory Browser would be the next major version update due to removal of a feature. Maybe not an issue at all to have two major version increments in short time (if the removal happens soon).

[Update]: Changed to prepare for v2.0.0, no longer v1.1.0.

@jonahgraham , @thegecko , opinions on this would be much appreciated.

extension renaming

Signed-off-by: Jens Reinecke <[email protected]>
Signed-off-by: Jens Reinecke <[email protected]>
Signed-off-by: Jens Reinecke <[email protected]>
Copy link
Contributor

@jonahgraham jonahgraham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The extension will show now with a different name in Open VSX. And after installation in VS Code.

+1 to update the name to this

  • This could be a reason for a major version change, i.e. to v2.0.0. But I believe removal of the Memory Browser would be the next major version update due to removal of a feature. Maybe not an issue at all to have two major version increments in short time (if the removal happens soon).

I think you should jump to 2.0, we can have a 3.0 soon after too. But I don't feel strongly that the changes so far necessitate the change from 1.1 -> 2.0

@jreineckearm
Copy link
Contributor Author

I think you should jump to 2.0, we can have a 3.0 soon after too.

In this case, I believe we also should remove the note at the top of the README.MD. Doesn't feel right to talk about a preliminary milestone release anymore when bumping major versions.

> Note: This is a preliminary milestone release. Please help us by trying out this extension and providing feedback using [our github issues page](https://github.com/eclipse-cdt-cloud/cdt-gdb-vscode/issues).

Signed-off-by: Jens Reinecke <[email protected]>
Signed-off-by: Jens Reinecke <[email protected]>
@jreineckearm jreineckearm changed the title v1.1.0 preparations v2.0.0 preparations Jan 20, 2025
@jreineckearm
Copy link
Contributor Author

Should anything else change on this PR before we can get serious with making a release?

Copy link
Contributor

@jonahgraham jonahgraham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renew my approval.

@jreineckearm
Copy link
Contributor Author

Thanks! @thegecko , would you mind merging this PR and then push a v2.0.0 tag to main to kick off a release?

@thegecko thegecko merged commit 180a662 into eclipse-cdt-cloud:main Jan 23, 2025
5 checks passed
@thegecko
Copy link

https://github.com/eclipse-cdt-cloud/cdt-gdb-vscode/actions/runs/12927145780

@jreineckearm jreineckearm deleted the release-preparations branch January 23, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants