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 instructions for running developer scripts #80

Merged
merged 1 commit into from Jun 20, 2023

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Jun 20, 2023

Motivation

close #79

Modifications

Update script permission

Copy link
Collaborator

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

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

Ah good catch - we intentionally wanted to avoid the individual scripts being executable, so this is intentional. Can you instead update the docs to say that one should run it as bash ./scripts/... please?

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 20, 2023

Ah good catch - we intentionally wanted to avoid the individual scripts being executable, so this is intentional. Can you instead update the docs to say that one should run it as bash ./scripts/... please?

Got it. In that case can we consider only adding executable permission to generate-contributors-list.sh instead of updating docs.

Expected Result

total 72
drwxr-xr-x  11 kyle  staff   352B  6 20 13:18 .
drwxr-xr-x@ 27 kyle  staff   864B  6 20 13:18 ..
-rw-r--r--   1 kyle  staff   1.2K  6 20 13:18 check-for-broken-symlinks.sh
-rw-r--r--   1 kyle  staff   1.3K  6 20 13:18 check-for-docc-warnings.sh
-rw-r--r--   1 kyle  staff   1.3K  6 20 13:18 check-for-unacceptable-language.sh
-rw-r--r--   1 kyle  staff   3.7K  6 20 13:18 check-license-headers.sh
-rwxr-xr-x   1 kyle  staff   1.9K  6 20 13:19 generate-contributors-list.sh
-rw-r--r--   1 kyle  staff   2.2K  6 20 13:18 run-integration-test.sh
-rw-r--r--   1 kyle  staff   1.5K  6 20 13:18 run-swift-format.sh
-rwxr-xr-x   1 kyle  staff   1.4K  6 19 23:50 soundness.sh
-rw-r--r--   1 kyle  staff   106B  6 19 23:50 unacceptable-language.txt

@czechboy0
Copy link
Collaborator

No, I think what you have in the PR now is good - just update the docs, without adding executable permissions to additional files.

@czechboy0
Copy link
Collaborator

@swift-server-bot add to allowlist

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 20, 2023

No, I think what you have in the PR now is good - just update the docs, without adding executable permissions to additional files.

Got it.

@simonjbeaumont simonjbeaumont changed the title Fix script file permission issue docs: Update instructions for running developer scripts Jun 20, 2023
@simonjbeaumont simonjbeaumont added the semver/none No version bump required. label Jun 20, 2023
@simonjbeaumont simonjbeaumont merged commit 1c07b5d into apple:main Jun 20, 2023
4 checks passed
@Kyle-Ye Kyle-Ye deleted the bugfix/permission branch June 20, 2023 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Script to generate the contributor list has incorrect documentation
3 participants