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

init script: create link for .wokeignore #136

Merged
merged 1 commit into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,17 @@ cp -R "$temp_directory"/* "$temp_directory"/.??* "$install_directory"

# Move workflow files and configuration
if [ "$install_directory" != "." ]; then
echo "Moving workflow files and configuration..."
echo "Moving workflow files and configuration..."
if [ ! -d .github/workflows ]; then
mkdir -p .github/workflows
fi
mv "$install_directory/.github/workflows"/* .github/workflows
mv "$install_directory/.github/.jira_sync_config.yaml" .github/
if [ ! -f .wokeignore ]; then
ru-fu marked this conversation as resolved.
Show resolved Hide resolved
ln -s "$install_directory/.wokeignore"
else
echo "ACTION REQUIRED: Found a .wokeignore file in the root directory. Include the contents from $install_directory/.wokeignore in this file!"
fi
fi

# Clean up
Expand Down
1 change: 1 addition & 0 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ To add documentation to an existing code repository:
#. copy the file(s) located in the ``docs/.github/workflows`` directory into
the code repository's ``.github/workflows`` directory
#. in the above workflow file(s), change the value of the ``working-directory`` field from ``.`` to ``docs``
#. create a symbolic link to the ``docs/.wokeignore`` file from the root directory of the code repository
#. in file ``docs/.readthedocs.yaml`` set the following:

* ``configuration: docs/conf.py``
Expand Down