feat: allow defining a git service from defaults.ini #694
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oracle-contributor-agreement
bot
added
the
OCA Verified
tromai
changed the title
tromai
force-pushed
the
693-support-defining-a-generic-git-service-through-defaultsini-for-build-tool-detection
branch
2 times, most recently
from
e7e7b48 to
f1dd0a1
Compare
nicallen
reviewed
Apr 16, 2024
docs/source/pages/using.rst
Outdated
| If the repository remote URL is from an unknown git service (see :ref:`Git Services <supported_git_services>` for a list of supported git services in Macaron), Macaron won't recognize it when analyzing the repository. | ||
|
|
||
| You would need to tell Macaron about that git service through the ``defaults.ini`` config. | ||
| For example, let's say you want to analyze the Bitbucket repository at ``https://bitbucket.org/snakeyaml/snakeyaml``. First, you need to create a ``defaults.ini`` file in the current workspace with the following content: |
There was a problem hiding this comment.
I'm not sure using bitbucket.org as the example is a good idea, since this is a well-known public git service that in principle we should support at some point, rendering this example meaningless (and the same goes for any other real public git service one might choose). Using a nonexistent hostname as the example (e.g. git.example.com) would probably be better, at the cost of making the example not concretely executable.
There was a problem hiding this comment.
I agree. Using bitbucket.org is not the best way to demonstrate an unknown generic git service.
nicallen
reviewed
Apr 16, 2024
docs/source/pages/using.rst
Outdated
|
|
||
| The ``-lr`` flag configure Macaron to looks into ``path/to/boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`. | ||
| The ``-lr`` flag tells Macaron to look into ``path/to/boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`. |
There was a problem hiding this comment.
path/to/boo/foo -> ./boo/foo to be consistent with the change above.
tromai
force-pushed
the
693-support-defining-a-generic-git-service-through-defaultsini-for-build-tool-detection
branch
from
f1dd0a1 to
a05ef37
Compare
benmss
reviewed
Apr 17, 2024
nathanwn
reviewed
Apr 17, 2024
nathanwn
reviewed
Apr 17, 2024
nathanwn
reviewed
Apr 17, 2024
nathanwn
reviewed
Apr 17, 2024
nathanwn
reviewed
Apr 17, 2024
src/macaron/slsa_analyzer/git_service/local_repo_git_service.py
Outdated
Show resolved
Hide resolved
nathanwn
approved these changes
Apr 17, 2024
nicallen
approved these changes
Apr 17, 2024
tromai
deleted the
693-support-defining-a-generic-git-service-through-defaultsini-for-build-tool-detection
branch
art1f1c3R
pushed a commit
that referenced
this pull request
Nov 29, 2024
Signed-off-by: Trong Nhan Mai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #693
Closes #332
LocalRepoGitService.defaults.ini. We should also document that if a domain is already supported in other services, it doesn't need to be allowed in this service.