Skip to content

fix: add missing README information and clean up types #273

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

Merged
merged 8 commits into from
Aug 3, 2024

Conversation

Parkreiner
Copy link
Member

@Parkreiner Parkreiner commented Jul 19, 2024

Little bit of cleanup to make the repo easier to maintain.

Changes made

  • Updated the main contributing guide to include release steps
  • Cleaned up TypeScript implementation
    • Turned strict mode on
    • Removed all any types
    • Updated all runtime code to account for type changes

Notes

  • Going to look into adding images or even a gif for the release steps; will look into this on Monday
  • I wanted to get the tsconfig.json file cleaned up, too (the compiler settings are technically invalid, even though nothing seems to break), but that took me down a rabbi thole of ESM-CSJ interop. Aiming to address that in a separate PR

@Parkreiner Parkreiner self-assigned this Jul 19, 2024
@stirby
Copy link
Contributor

stirby commented Jul 19, 2024

@matifali @Parkreiner can we cut a release as soon as this is merged?

@Parkreiner
Copy link
Member Author

@matifali @Parkreiner can we cut a release as soon as this is merged?

Atif and I just cut a release this afternoon. Were there any major changes after that? I would think this PR is just infrastructure stuff that won't affect end-users

Copy link
Collaborator

@bcpeinhardt bcpeinhardt left a comment

Choose a reason for hiding this comment

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

This is super useful on boarding info 😎

@@ -3,14 +3,14 @@
Modules
</h1>

[Registry](https://registry.coder.com) | [Coder Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Coder Enterprise](https://coder.com/docs/v2/latest/enterprise)
[Module Registry](https://registry.coder.com) | [Coder Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Coder Enterprise](https://coder.com/docs/v2/latest/enterprise)
Copy link
Member

Choose a reason for hiding this comment

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

Registry also hosts templates source code at https://registry.coder.com/templates


Following that, our automated processes will handle publishing new data for [`registry.coder.com`](https://github.com/coder/registry.coder.com/):

1. Publishing new versions to Coder's [Terraform Registry](https://registry.terraform.io/providers/coder/coder/latest)
Copy link
Member

Choose a reason for hiding this comment

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

We do not publish anything to terraform registry.

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Looking great for now. It may change once we implement independent versioning for each module.

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

We do not publish modules to terraform registry. i.e registry.terraform.io

@Parkreiner Parkreiner requested a review from matifali July 26, 2024 15:11
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Thank you. :)

@Parkreiner Parkreiner merged commit 310d026 into main Aug 3, 2024
2 checks passed
@matifali matifali deleted the mes/readme-update branch October 17, 2024 13:51
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.

4 participants