From c5c290903e756ba8e130260f97fe1472f751452d Mon Sep 17 00:00:00 2001 From: Dan Anstis Date: Fri, 9 Feb 2024 19:39:22 +1000 Subject: [PATCH] feat: move tag check out of project sync cycle (#193) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## **Type** enhancement, bug_fix ___ ## **Description** - Moved the Asana tag check and creation to occur before the project sync loop starts. This change enhances efficiency by preventing repeated checks and potential tag creations for each project within the loop. - Fixed a bug where the span was ended inside the loop, which could lead to incorrect span durations being reported. ___ ## **Changes walkthrough**
Relevant files
Enhancement
sync.py
Refactor Asana Tag Creation and Fix Span End Issue                         
ado_asana_sync/sync/sync.py
  • Moved the Asana tag check and creation out of the project sync loop.
  • Fixed an issue where the span ended prematurely.
    		• +7/-7     
    ✨ Usage guide:
    **Overview:** The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template: ``` /describe --pr_description.some_config1=... --pr_description.some_config2=... ``` With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_description] some_config1=... some_config2=... ```
    Enabling\disabling automation
    - When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is: ``` pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] ``` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. - Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: ``` pr_commands = ["/describe --pr_description.use_description_markers=true", ...] ``` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: - `type`: the PR type. - `summary`: the PR summary. - `walkthrough`: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
    Custom labels
    The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. If you specify [custom labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: - `Main topic:performance` - pr_agent:The main topic of this PR is performance - `New endpoint` - pr_agent:A new endpoint was added in this PR - `SQL query` - pr_agent:A new SQL query was added in this PR - `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile - ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
    Inline File Walkthrough 💎
    For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are: - `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. - `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. - `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
    Utilizing extra instructions
    The `describe` tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: ``` [pr_description] extra_instructions=""" - The PR title should be in the format: ': ' - The title should be short and concise (up to 10 words) - ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \<QUESTION\>**: Ask a question about the PR. > - **/update_changelog**: Update the changelog based on the PR's contents. > - **/add_docs** 💎: Generate docstring for new components introduced in the PR. > - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents. > - **/analyze** 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. >See the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [describe usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md) page for a comprehensive guide on using this tool. </details> --- .github/workflows/pragent.yml | 3 ++- ado_asana_sync/sync/sync.py | 18 +++++++++++------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/workflows/pragent.yml b/.github/workflows/pragent.yml index 27792c9..5470696 100644 --- a/.github/workflows/pragent.yml +++ b/.github/workflows/pragent.yml @@ -1,3 +1,5 @@ +name: Run pr agent on pull requests, respond to user comments + on: pull_request: issue_comment: @@ -8,7 +10,6 @@ jobs: issues: write pull-requests: write contents: write - name: Run pr agent on pull requests, respond to user comments steps: - name: PR Agent action step id: pragent diff --git a/ado_asana_sync/sync/sync.py b/ado_asana_sync/sync/sync.py index 38b6e99..4cdeee5 100644 --- a/ado_asana_sync/sync/sync.py +++ b/ado_asana_sync/sync/sync.py @@ -36,14 +36,18 @@ def start_sync(app: App) -> None: + try: + app.asana_tag_gid = create_tag_if_not_existing( + app, + get_asana_workspace(app, app.asana_workspace_name), + app.asana_tag_name, + ) + except Exception as exception: + _LOGGER.error("Failed to create or get Asana tag: %s", exception) + return while True: with _TRACER.start_as_current_span("start_sync") as span: span.add_event("Start sync run") - app.asana_tag_gid = create_tag_if_not_existing( - app, - get_asana_workspace(app, app.asana_workspace_name), - app.asana_tag_name, - ) projects = read_projects() for project in projects: sync_project(app, project) @@ -51,8 +55,8 @@ def start_sync(app: App) -> None: _LOGGER.info( "Sync process complete, sleeping for %s seconds", app.sleep_time ) - span.end() - sleep(app.sleep_time) + + sleep(app.sleep_time) def read_projects() -> list: