Skip to content

Update sample configuration and documentation#91

Merged
mattyjones merged 1 commit intoN0MoreSecr3ts:developfrom
sgobotta:update-sample-configuration
Feb 12, 2021
Merged

Update sample configuration and documentation#91
mattyjones merged 1 commit intoN0MoreSecr3ts:developfrom
sgobotta:update-sample-configuration

Conversation

@sgobotta
Copy link
Copy Markdown
Contributor

@sgobotta sgobotta commented Feb 9, 2021

This PR provides:

  • Configuration file sample.ymlupdate.
  • Documentation update in README.md

Motivation

The documentation and sample configuration file seemed to be out of date in contrast to the implementation in localPath.go and localRepo.go.

Update the yaml configuration file example, as well as the description in step 1 and the yaml example in the README.md file.

According to implementations found in scanLocalGitRepo.go:69 and scanLocalPath.go:85, the sample.yml and the quickstart instructions weren't referring to the updated parameter names.
@mattyjones mattyjones merged commit e504b56 into N0MoreSecr3ts:develop Feb 12, 2021
@mattyjones
Copy link
Copy Markdown
Collaborator

@sgobotta Thanks for catching this. Documentation is always the last thing updated.

mattyjones added a commit that referenced this pull request Apr 4, 2021
* clean up flags

* update

* update

* update flag strings

* formating issues

* webserver enable/disable flaf

* enhanced debug and header output

* csv and json output

* bring in ability to update signatures to a specific version

* Update sample configuration  and documentation (#91)

Update the yaml configuration file example, as well as the description in step 1 and the yaml example in the README.md file.

According to implementations found in scanLocalGitRepo.go:69 and scanLocalPath.go:85, the sample.yml and the quickstart instructions weren't referring to the updated parameter names.

* cleanup

* fix the progress bar

Still not quite right due to threads but better

* remove dead functions

* Updated the changelog

* implement persistent flags (#95)

move the flags that are common to all the commands into the root command. The updateRules command does not adhere to all the flags but for know we will deal with it.

Signed-off-by: Matty <urlugal@gmail.com>

Co-authored-by: Santiago Botta <sgobotta@gmail.com>
Co-authored-by: Matty <matty.j@innocentlivesfoundation.org>
mattyjones added a commit that referenced this pull request Apr 5, 2021
* clean up flags

* update

* update

* update flag strings

* formating issues

* webserver enable/disable flaf

* enhanced debug and header output

* csv and json output

* bring in ability to update signatures to a specific version

* Update sample configuration  and documentation (#91)

Update the yaml configuration file example, as well as the description in step 1 and the yaml example in the README.md file.

According to implementations found in scanLocalGitRepo.go:69 and scanLocalPath.go:85, the sample.yml and the quickstart instructions weren't referring to the updated parameter names.

* cleanup

* fix the progress bar

Still not quite right due to threads but better

* remove dead functions

* Updated the changelog

* implement persistent flags

move the flags that are common to all the commands into the root command. The updateRules command does not adhere to all the flags but for know we will deal with it.

Signed-off-by: Matty <urlugal@gmail.com>

* Cleanup

Signed-off-by: Matty <urlugal@gmail.com>

* implement persistent flags (#95)

move the flags that are common to all the commands into the root command. The updateRules command does not adhere to all the flags but for know we will deal with it.

Signed-off-by: Matty <urlugal@gmail.com>

Co-authored-by: Santiago Botta <sgobotta@gmail.com>
Co-authored-by: Matty <matty.j@innocentlivesfoundation.org>
@sgobotta
Copy link
Copy Markdown
Contributor Author

sgobotta commented Apr 8, 2021

@sgobotta Thanks for catching this. Documentation is always the last thing updated.

Glad to contribute 👌

mattyjones added a commit that referenced this pull request Apr 29, 2021
* Develop (#97)

* clean up flags

* update

* update

* update flag strings

* formating issues

* webserver enable/disable flaf

* enhanced debug and header output

* csv and json output

* bring in ability to update signatures to a specific version

* Update sample configuration  and documentation (#91)

Update the yaml configuration file example, as well as the description in step 1 and the yaml example in the README.md file.

According to implementations found in scanLocalGitRepo.go:69 and scanLocalPath.go:85, the sample.yml and the quickstart instructions weren't referring to the updated parameter names.

* cleanup

* fix the progress bar

Still not quite right due to threads but better

* remove dead functions

* Updated the changelog

* implement persistent flags

move the flags that are common to all the commands into the root command. The updateRules command does not adhere to all the flags but for know we will deal with it.

Signed-off-by: Matty <urlugal@gmail.com>

* Cleanup

Signed-off-by: Matty <urlugal@gmail.com>

* implement persistent flags (#95)

move the flags that are common to all the commands into the root command. The updateRules command does not adhere to all the flags but for know we will deal with it.

Signed-off-by: Matty <urlugal@gmail.com>

Co-authored-by: Santiago Botta <sgobotta@gmail.com>
Co-authored-by: Matty <matty.j@innocentlivesfoundation.org>

* bump version and update changelog

* Update CHANGELOG.md

* Adding github-enterprise-url, fixing auth, fixing standard vs. enterprise org/repo/user param differentiation, fixing expaand-orgs mispelling

Co-authored-by: Matt Jones <mattyjones@users.noreply.github.com>
Co-authored-by: Santiago Botta <sgobotta@gmail.com>
Co-authored-by: Matty <matty.j@innocentlivesfoundation.org>
Co-authored-by: Matty <urlugal@gmail.com>
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.

2 participants