Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update documentation #324

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Update documentation #324

merged 1 commit into from
Nov 13, 2024

Conversation

courtney-sims
Copy link
Contributor

Updates repo documentation to:

  • change references from publish to deploy
  • add a contributing guide with release info and acknowledgement that node 23 is not yet supported
  • add example for multiline commands
  • add example for setting a secret for a specific environment: How can you set worker secret for a specific environment? #251
  • remove --experimental-versions flags from commands that no longer require them

@courtney-sims courtney-sims requested review from a team as code owners November 12, 2024 22:30
@courtney-sims courtney-sims force-pushed the courtney-sims-documentation-update branch 2 times, most recently from 6042e3d to 79de25a Compare November 13, 2024 16:40
Maximo-Guk
Maximo-Guk reviewed Nov 13, 2024
View reviewed changes
CHANGELOG.md Outdated
@@ -206,8 +206,8 @@

- New `command` input
- This allows you to specify the Wrangler command you would like to run.
For example, if you want to publish the production version of your Worker you may run `publish --env=production`.
- This opens up other possibilities too like publishing a Pages project: `pages publish <directory> --project-name=<name>`.
Copy link
Member

Choose a reason for hiding this comment

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

We should update command to deploy as well https://developers.cloudflare.com/workers/wrangler/commands/#pages

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I saw this, but assumed we wouldn't want to retroactively update a changelog since this is tied to a specific version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant to remove this completely

jahands
jahands reviewed Nov 13, 2024
View reviewed changes
CHANGELOG.md Outdated
For example, if you want to publish the production version of your Worker you may run `publish --env=production`.
- This opens up other possibilities too like publishing a Pages project: `pages publish <directory> --project-name=<name>`.
For example, if you want to deploy the production version of your Worker you may run `publish --env=production`.
- This opens up other possibilities too like deploying a Pages project: `pages publish <directory> --project-name=<name>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

209 and 210 also say publish instead of deploy

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above. Sorry about that!

Maximo-Guk
Maximo-Guk reviewed Nov 13, 2024
View reviewed changes
README.md Outdated
@@ -345,3 +375,4 @@ jobs:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
```
````
Copy link
Member

Choose a reason for hiding this comment

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

Looks like the README.md markdown isn't rendering correctly, maybe because of this stray ````?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Fixed :)

Maximo-Guk
Maximo-Guk reviewed Nov 13, 2024
View reviewed changes
README.md
@@ -220,7 +234,7 @@ For more advanced usage or to programmatically trigger the workflow from scripts

### Upload a Worker Version

To create a new version of your Worker that is not deployed immediately, use the `wrangler versions upload --experimental-versions` command. Worker versions created in this way can then be deployed all at once at a later time or gradually deployed using the `wranger versions deploy --experimental-versions` command or via the Cloudflare dashboard under the Deployments tab. For now, the `--experimental-versions` flag and wrangler v3.40.0 or above is required to use this feature.
Copy link
Member

Choose a reason for hiding this comment

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

I would confirm with wrangler team to see if --experimental-versions flag is still required or not, looks like it's still referenced here for example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It has been confirmed!

@courtney-sims courtney-sims force-pushed the courtney-sims-documentation-update branch 3 times, most recently from c1338a5 to bd64420 Compare November 13, 2024 18:05
@courtney-sims courtney-sims force-pushed the courtney-sims-documentation-update branch from bd64420 to 0140ffb Compare November 13, 2024 18:06
@courtney-sims courtney-sims merged commit ac2fd0e into main Nov 13, 2024
4 checks passed
@courtney-sims courtney-sims deleted the courtney-sims-documentation-update branch November 13, 2024 22:49
@courtney-sims courtney-sims mentioned this pull request Nov 14, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jahands jahands jahands left review comments

@Maximo-Guk Maximo-Guk Maximo-Guk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@courtney-sims @jahands @Maximo-Guk