Skip to content

docs: Change sha256 checksum in docs to more realistic example#2987

Merged
johanneskoester merged 2 commits intosnakemake:mainfrom
wimglenn:sha256
Aug 13, 2024
Merged

docs: Change sha256 checksum in docs to more realistic example#2987
johanneskoester merged 2 commits intosnakemake:mainfrom
wimglenn:sha256

Conversation

@wimglenn
Copy link
Copy Markdown
Contributor

It is strange/confusing that the example checksum in the docs does not look like a sha256.

I've changed it to a real hexdigest (the sha256 of the content b"test", as was also used in the tests:

sha256 = "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
rule c:
output:
ensure("test3.txt", sha256=sha256)
shell:
"echo -n test > {output}"

ref: https://stackoverflow.com/questions/78801757/what-is-the-encoding-of-this-sha256-hash-in-the-snakemake-documentation

It is strange/confusing that the example checksum in the docs does not look like a sha256.

I've changed it to a real hexdigest (the sha256 of the content b"test", as was also used in the tests:
https://github.com/snakemake/snakemake/blob/e8735c1477a2a82110757ba86bbd1ccbcaf327ba/tests/test_ensure/Snakefile#L17-L24

ref: https://stackoverflow.com/questions/78801757/what-is-the-encoding-of-this-sha256-hash-in-the-snakemake-documentation
@wimglenn wimglenn changed the title Change sha256 checksum in docs to more realistic example docs: Change sha256 checksum in docs to more realistic example Jul 27, 2024
@Hugovdberg
Copy link
Copy Markdown
Contributor

Thank you for spotting that and suggesting a fix. However, the current testsuite fails on an unrelated issue, which I think is caused by numpy 2. The last successful run of the test suite still ran numpy 1.26. I will try to find in which spots we need to fix the numpy version to <2 in order to get the original tests running again. You can then pull in those changes to get this PR up and running again.

@Hugovdberg
Copy link
Copy Markdown
Contributor

Work in progress, but there are more issues with the tests, follow #2988 for more info

@johanneskoester
Copy link
Copy Markdown
Contributor

tests fixed.

@johanneskoester johanneskoester enabled auto-merge (squash) August 13, 2024 09:58
@johanneskoester
Copy link
Copy Markdown
Contributor

thanks!

@sonarqubecloud
Copy link
Copy Markdown

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 13, 2024

Warning

Rate limit exceeded

@johanneskoester has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 5 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b70c0db and 319cdb0.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@johanneskoester johanneskoester merged commit 16a5cf2 into snakemake:main Aug 13, 2024
johanneskoester pushed a commit that referenced this pull request Aug 13, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.17.0](v8.16.0...v8.17.0)
(2024-08-13)


### Features

* fix job rate limiting with --max-jobs-per-second and introduce the
more flexible --max-jobs-per-timespan
([#3010](#3010))
([9c31257](9c31257))


### Bug Fixes

* Allow hyphens in config keys given on the command line.
([#2998](#2998))
([b70c0db](b70c0db))
* allowing trailing '+' in name patterns
([#3002](#3002))
([59150d3](59150d3))
* print message if not yet enough resources for executing further jobs
([b8df036](b8df036))
* unawaited coroutine sanitize_local_storage_copies
([#2972](#2972))
([715c572](715c572))


### Documentation

* Change sha256 checksum in docs to more realistic example
([#2987](#2987))
([16a5cf2](16a5cf2))
* Make it more clear that the cluster commands now require a plugin
([#2976](#2976))
([74134cf](74134cf))
* Update installation.rst to recommend Miniforge instead of Mambaforge
([#2975](#2975))
([0fc7619](0fc7619))
* use plain monospace font instead of theme default that changes &gt;=
into ≥
([cc17fc1](cc17fc1))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@wimglenn wimglenn deleted the sha256 branch August 13, 2024 15:49
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