Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update skip commit files docs #670

Merged
merged 2 commits into from
Nov 6, 2023
Merged

Conversation

abeizn
Copy link
Contributor

@abeizn abeizn commented Nov 6, 2023

Summary

docs: update skip commit files docs

Does this close any open issues?

Closes na

Screenshots

Include any relevant screenshots here.

Other Information

Any other information that is important to this PR.

@@ -15,6 +15,8 @@ This plugin extracts commits and references from a remote or local git repositor
NOTE: you can run only one issue collection stage as described in the Github Plugin README.
3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits` table.

Note: If you do not want to collect commit files, you can bypass this step by setting the SKIP_COMMIT_FILES=true in environment variable or .env file. This will prevent the plugin from collecting commit file data.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please update the copywriting from 'in environment variable or .env file' to 'in the .env file'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

2. Errors occurred while writing data to the DevLake database

To address this, you can bypass this step by setting the SKIP_COMMIT_FILES=true in environment variable or .env file.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

@Startrekzky Startrekzky left a comment

Choose a reason for hiding this comment

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

LGTM

@abeizn abeizn merged commit 7d8b802 into main Nov 6, 2023
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