Skip to content

refactor: update Makefile organization; update DEVELOPING.md instructions#1212

Merged
spiffcs merged 7 commits intomainfrom
makefile-update
Sep 19, 2022
Merged

refactor: update Makefile organization; update DEVELOPING.md instructions#1212
spiffcs merged 7 commits intomainfrom
makefile-update

Conversation

@spiffcs
Copy link
Copy Markdown
Contributor

@spiffcs spiffcs commented Sep 16, 2022

Summary

  • update Makefile variable organization
  • make DEFAULT_GOAL:=help for Makefile
  • update Makefile self-documentation
  • update DEVELOPING.md instruction

Signed-off-by: Christopher Phillips christopher.phillips@anchore.com

@spiffcs
wip
3e1a949 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@spiffcs
Merge branch 'main' into makefile-update
2cfcf6f 
* main:
  refactor: replace ioutil=>io; update linter (#1211)
@spiffcs
remove help text from release
1f05741 
- release command is not a manual command - remove from help output

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@spiffcs
update DEVELOPING.md with extra steps and sample
6e8f0f4 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@spiffcs
update timeout based on latest master failure
637c8a7 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@spiffcs
remove typo
ce09b90 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@spiffcs
reorder instruction
6fff771 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 16, 2022

Benchmark Test Results

Benchmark results from the latest changes vs base branch 
name                                                       old time/op    new time/op    delta
ImagePackageCatalogers/alpmdb-cataloger-2                    14.3ms ± 2%    13.9ms ±11%    ~     (p=0.190 n=4+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2              1.63ms ± 2%    1.58ms ± 6%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2            4.07ms ± 2%    3.83ms ± 3%  -5.96%  (p=0.008 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2    1.33ms ± 3%    1.26ms ± 1%  -5.46%  (p=0.008 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         918µs ± 1%     880µs ± 2%  -4.07%  (p=0.008 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                    1.10ms ± 1%    1.03ms ± 1%  -6.50%  (p=0.008 n=5+5)
ImagePackageCatalogers/rpm-db-cataloger-2                    1.58ms ± 2%    1.51ms ± 2%  -4.36%  (p=0.008 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      18.1ms ± 3%    17.3ms ± 2%  -4.71%  (p=0.008 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.54ms ± 2%    1.45ms ± 1%  -5.81%  (p=0.008 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2          2.77µs ± 8%    2.60µs ± 2%  -5.99%  (p=0.008 n=5+5)
ImagePackageCatalogers/dotnet-deps-cataloger-2               1.69ms ± 1%    1.59ms ± 2%  -5.76%  (p=0.008 n=5+5)
ImagePackageCatalogers/portage-cataloger-2                    864µs ± 2%     846µs ± 2%    ~     (p=0.151 n=5+5)

name                                                       old alloc/op   new alloc/op   delta
ImagePackageCatalogers/alpmdb-cataloger-2                    5.26MB ± 0%    5.26MB ± 0%    ~     (p=0.421 n=5+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2               202kB ± 0%     202kB ± 0%    ~     (p=0.278 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2             945kB ± 0%     944kB ± 0%    ~     (p=0.421 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     214kB ± 0%     214kB ± 0%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         158kB ± 0%     158kB ± 0%    ~     (p=0.206 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                     203kB ± 0%     203kB ± 0%    ~     (p=0.968 n=5+5)
ImagePackageCatalogers/rpm-db-cataloger-2                     302kB ± 0%     302kB ± 0%    ~     (p=1.000 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      3.44MB ± 0%    3.44MB ± 0%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.25MB ± 0%    1.25MB ± 0%    ~     (p=0.452 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2            672B ± 0%      672B ± 0%    ~     (all equal)
ImagePackageCatalogers/dotnet-deps-cataloger-2                369kB ± 0%     369kB ± 0%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/portage-cataloger-2                    136kB ± 0%     136kB ± 0%    ~     (p=0.833 n=5+5)

name                                                       old allocs/op  new allocs/op  delta
ImagePackageCatalogers/alpmdb-cataloger-2                     85.7k ± 0%     85.7k ± 0%    ~     (p=0.444 n=5+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2               4.25k ± 0%     4.25k ± 0%    ~     (all equal)
ImagePackageCatalogers/python-package-cataloger-2             16.6k ± 0%     16.6k ± 0%    ~     (p=0.214 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     5.53k ± 0%     5.53k ± 0%    ~     (p=0.794 n=4+5)
ImagePackageCatalogers/javascript-package-cataloger-2         3.32k ± 0%     3.32k ± 0%    ~     (p=0.556 n=4+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                     4.60k ± 0%     4.60k ± 0%    ~     (all equal)
ImagePackageCatalogers/rpm-db-cataloger-2                     8.13k ± 0%     8.13k ± 0%    ~     (all equal)
ImagePackageCatalogers/java-cataloger-2                       57.5k ± 0%     57.5k ± 0%    ~     (p=0.421 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                      5.43k ± 0%     5.43k ± 0%    ~     (p=1.000 n=5+4)
ImagePackageCatalogers/go-module-binary-cataloger-2            15.0 ± 0%      15.0 ± 0%    ~     (all equal)
ImagePackageCatalogers/dotnet-deps-cataloger-2                7.27k ± 0%     7.27k ± 0%    ~     (all equal)
ImagePackageCatalogers/portage-cataloger-2                    3.59k ± 0%     3.59k ± 0%    ~     (p=0.444 n=5+5)

@spiffcs spiffcs requested a review from wagoodman September 16, 2022 19:07
kzantow
kzantow reviewed Sep 16, 2022
View reviewed changes
Comment thread Makefile
endef

## Default Task
.DEFAULT_GOAL:=help
Copy link
Copy Markdown
Contributor

@kzantow kzantow Sep 16, 2022

Choose a reason for hiding this comment

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

maybe just stick the help goal here -- as I understand it, the first goal is the default in a makefile?

kzantow
kzantow approved these changes Sep 16, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@kzantow kzantow left a comment

Choose a reason for hiding this comment

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

LGTM just maybe one small simplification

@spiffcs spiffcs merged commit ad263e6 into main Sep 19, 2022
@spiffcs spiffcs deleted the makefile-update branch September 19, 2022 14:38
spiffcs added a commit to luhring/syft that referenced this pull request Sep 19, 2022
@spiffcs
Merge branch 'main' into apk-dependencies
2773d08 
* main:
  bug: remove chance for panic; provide default attestation path (anchore#1214)
  refactor: update Makefile organization; update DEVELOPING.md instructions (anchore#1212)
  refactor: replace ioutil=>io; update linter (anchore#1211)
  Update bootstrap tools to latest versions. (anchore#1204)
  Add gosimports (anchore#1205)
  refactor: move formats from internal into syft module (anchore#1172)
  warn on errors from RPM DB parsing (anchore#1200)
  docs: improve Singularity image source docs (anchore#1190)

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
spiffcs added a commit that referenced this pull request Sep 19, 2022
@spiffcs
refactor: update Makefile organization; update DEVELOPING.md instruct…
3c2adec 
…ions (#1212)

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
aiwantaozi pushed a commit to aiwantaozi/syft that referenced this pull request Oct 20, 2022
@spiffcs @aiwantaozi
refactor: update Makefile organization; update DEVELOPING.md instruct…
f67506b 
…ions (anchore#1212)
spiffcs added a commit that referenced this pull request Oct 21, 2022
@spiffcs
refactor: update Makefile organization; update DEVELOPING.md instruct…
48ae490 
…ions (#1212)

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
spiffcs added a commit that referenced this pull request Oct 21, 2022
@spiffcs
refactor: update Makefile organization; update DEVELOPING.md instruct…
fecf6fe 
…ions (#1212)

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
@spiffcs
refactor: update Makefile organization; update DEVELOPING.md instruct…
f6c8afd 
…ions (anchore#1212)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kzantow kzantow kzantow approved these changes

@wagoodman wagoodman Awaiting requested review from wagoodman

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@spiffcs @kzantow