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.

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

docs(weaver): tutorial documentation updates and additions of license declarations #2692

Merged
merged 8 commits into from
Sep 18, 2023

Conversation

VRamakrishna
Copy link
Contributor

  • Fixed various links, path names, and package names, and corrected typos, in the Weaver tutorial documents. This was done after following the instructions outlined in the docs to manually run sample applications.
  • Added Apache-2 license declarations to various source files in the weaver folder where they were missing. The main weaver folder already contains a LICENSE.md file, so this just covers all of our bases.
  • Updated README instructions in various folders, wherever they were out of date.
  • Updated version numbers in some template configuration files to 2.0.0-alpha.1.

There is no code change in this PR. Just changes in Markdown files and addition of comments to source files.

@gitguardian
Copy link

gitguardian bot commented Sep 15, 2023

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id Secret Commit Filename
- Generic CLI Secret f4a108a weaver/samples/fabric/fabric-cli/scripts/createUsers.sh View secret
- Generic CLI Secret f4a108a weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
- Generic CLI Secret f4a108a weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@VRamakrishna
Copy link
Contributor Author

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.
🔎 Detected hardcoded secrets in your pull request

GitGuardian id Secret Commit Filename
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/fabric-cli/scripts/createUsers.sh View secret
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
🛠 Guidelines to remediate hardcoded secrets

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.Our GitHub checks need improvements? Share your feedbacks!

This is not a cause for concern. The files listed above contain sample secrets used for testing purposes. Their exposure produces no harm.

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@VRamakrishna LGTM, thank you!

@petermetz
Copy link
Contributor

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.
🔎 Detected hardcoded secrets in your pull request
GitGuardian id Secret Commit Filename
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/fabric-cli/scripts/createUsers.sh View secret
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
- Generic CLI Secret 0c1ed02 weaver/samples/fabric/go-cli/scripts/initAsset.sh View secret
🛠 Guidelines to remediate hardcoded secrets
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.Our GitHub checks need improvements? Share your feedbacks!

This is not a cause for concern. The files listed above contain sample secrets used for testing purposes. Their exposure produces no harm.

@VRamakrishna FYI: I've just modified the branch protection rules to not require the GitGuardian check to pass because they still don't support (from what I gathered so far) ignoring certain paths and so we can't use it. In the meantime GitHub also came out with a continuous secret scanning solution that we plan on putting to good use soon.

…ommon protobufs

Also fixed typos in a Weaver RFC.

Signed-off-by: VRamakrishna <[email protected]>
…cript and TypeScript files

Signed-off-by: VRamakrishna <[email protected]>
…les to 2.0.0-alpha.1

Updated various go.sum files after dependency version changes.
Fixed a license declaration.

Signed-off-by: VRamakrishna <[email protected]>
Fixed typos.

Updated modules' instructions pages.

[skip ci]

Signed-off-by: VRamakrishna <[email protected]>
@petermetz petermetz merged commit 412093e into hyperledger-cacti:main Sep 18, 2023
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