René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"feat: Commit parser w/ path filter for monorepos","articleBody":"## Description\r\n\r\nAdding the `use_only_cwd_commits` config makes it possible to make the semantic release look for commits in the `cwd` folder only.\r\n\r\nThe default behavior is any commit in the repo can trigger a package release.\r\n\r\nhttps://github.com/python-semantic-release/python-semantic-release/blob/master/semantic_release/vcs_helpers.py#L19-L26\r\n```python\r\n_repo: Optional[Repo]\r\n_sub_directory = \"\"\r\ntry:\r\n    _repo = Repo(\".\", search_parent_directories=True)\r\n    if config.get(\"use_only_cwd_commits\") and config.get(\"version_source\") == \"commit\":\r\n        _sub_directory = os.path.relpath(os.getcwd(), _repo.working_dir)\r\nexcept InvalidGitRepositoryError:\r\n    _repo = None\r\n```\r\n\r\nit will be good to have a config option to define one or more folders in the repo to semantic release CLI look for commits.\r\n\r\n## Use cases\r\n\r\n**Monorepo**: When you have multiple packages in the same repo, you can use `use_only_cwd_commits` to force the semantic release to look for commits only in the package folder.\r\n\r\nHowever, when you have local dependencies that could potentially trigger the release of the application, it is required to look at multiple folders to decide if a release is necessary.\r\n\r\nIssue reference: https://github.com/lucasvieirasilva/nx-plugins/issues/122\r\n\r\nExample:\r\n\r\n```text\r\n- apps/app1/pyproject.toml\r\n- libs/lib1/pyproject.toml\r\n```\r\n\r\nIn this example, `app1` references `lib1` as a local dependency using the Poetry path reference https://python-poetry.org/docs/dependency-specification/#path-dependencies\r\n\r\n```toml\r\n...\r\n[tool.poetry]\r\nname = \"app1\"\r\n...\r\n\r\n    [tool.poetry.dependencies.lib1]\r\n    path = \"../../libs/lib1\"\r\n    develop = true\r\n...\r\n```\r\n\r\nIf something changes in the `lib1` it should trigger the `app1` release, however, the commit path is only in the `libs/lib1` folder, not in the `apps/app1` folder.\r\n\r\nIn this case, the `use_only_cwd_commits` config isn't gonna work.\r\n\r\n If we have the option to specify multiple paths for the commit analyzer, I could explicitly reference `libs/lib1` in the `apps/app1/pyproject.toml` semantic release config.\r\n\r\n## Possible implementation\r\n\r\n- a new config entry `commit_paths` that accepts a list of paths.\r\n\r\n```toml\r\n[tool.semantic_release]\r\nversion_variable = [\r\n    \"pyproject.toml:version\"\r\n]\r\nbranch = \"main\"\r\nupload_to_pypi = false\r\nupload_to_release = false\r\ncommit_paths = [\r\n    \"apps/app1\",\r\n    \"libs/lib1\"\r\n]\r\n```\r\n\r\n","author":{"url":"https://github.com/lucasvieirasilva","@type":"Person","name":"lucasvieirasilva"},"datePublished":"2023-06-26T14:32:53.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":9},"url":"https://github.com/614/python-semantic-release/issues/614"}