oss-fuzz/docs
Joyce 3cbb8c9d6e
Show minimal permission needed for CIFuzz workflow (#10283)
I'm suggesting this change in the CIFuzz example workflow to indicate
the minimal permission needed for the workflow to run and also to follow
the OpenSSF Scorecard Token Permission Check recommendations.

I've tested with
https://github.com/joycebrum/sigstore/actions/runs/4918728701 and the
action ran with success with no permission granted.

the actions/upload-artifact skipped does not need permission to upload
artifacts as can be seen at
https://github.com/joycebrum/sigstore/actions/runs/4928734763

---------

Signed-off-by: Joyce <joycebrum@google.com>
Signed-off-by: jonathanmetzman <31354670+jonathanmetzman@users.noreply.github.com>
Co-authored-by: jonathanmetzman <31354670+jonathanmetzman@users.noreply.github.com>
2023-06-15 17:16:44 -04:00
..
advanced-topics FIX: update broken hyperlink in the docs (#10467) 2023-06-05 14:44:15 -04:00
further-reading docs: remove minijail doc. (#6285) 2021-08-24 07:14:37 -07:00
getting-started Show minimal permission needed for CIFuzz workflow (#10283) 2023-06-15 17:16:44 -04:00
images Update OSS-Fuzz process image. (#7248) 2022-02-08 10:02:37 -05:00
oss-fuzz doc: replace libfuzzer.info links with llvm.org (#10131) 2023-04-24 11:35:51 +10:00
reference doc: replace libfuzzer.info links with llvm.org (#10131) 2023-04-24 11:35:51 +10:00
.gitignore Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
404.html Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
Gemfile Update docs gems (#8115) 2022-08-02 10:44:36 +10:00
Gemfile.lock build(deps): bump commonmarker from 0.23.7 to 0.23.9 in /docs (#10065) 2023-04-14 08:20:12 -04:00
README.md Update README.md (#9576) 2023-02-06 10:32:48 -05:00
_config.yml Updated Google Analytics (#9777) 2023-02-23 13:00:42 +11:00
faq.md doc: replace libfuzzer.info links with llvm.org (#10131) 2023-04-24 11:35:51 +10:00
favicon.ico Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
glossary.md Documentation fixes. (#2705) 2019-08-15 15:07:23 -07:00
ideal_integration.md Update ideal_integration.md 2019-08-22 11:28:24 -07:00
index.md Update README and Docs to add recent blog article and update trophy stats (#9567) 2023-02-03 00:02:44 +00:00
new_project_guide.md Documentation fixes. (#2705) 2019-08-15 15:07:23 -07:00
reproducing.md Add redirect for old reproducing.md (#2666) 2019-08-07 12:57:10 -07:00

README.md

Readme

Use the following instructions to make documentation changes locally.

Prerequisites

$ sudo apt install ruby bundler
$ bundle config set path 'vendor/bundle'
$ bundle install

Serving locally

$ bundle exec jekyll serve

Theme documentation

We are using the just the docs theme.