Fix two small issues encountered when implementing in a real repo

[DukeFerdinand]

Alaska Airlines Pull Request

Before Submitting this pull request:

• Link all tickets in this repository related to this PR in the Development section note: all pull requests require at least one linked ticket
• If this PR is Ready For Review, all ticket's linked under Development must have their status changed to Ready For Review as well

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Fast follow on #59

Closes #59

Summary by Sourcery

Fix an issue with README.md processing by setting the overwrite flag to false and enhance the script with a warning log message to alert users about the overwrite setting.

Bug Fixes:

• Fix issue with README.md processing by ensuring the overwrite flag is set to false, preventing unintended overwrites.

Enhancements:

• Add a warning log message to notify users when the overwrite flag for README.md is set to false, prompting updates when template changes are merged.

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This pull request addresses two small issues encountered during implementation in a real repository. The changes are focused on the generateDocs.mjs file, specifically modifying the process for generating the README.md file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Modify README.md generation process	Add a warning log message about README.md overwrite setting Set 'overwrite' option to false for README.md processing	scripts/build/generateDocs.mjs

---

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

[rmenner]

@DukeFerdinand Just to be super clear since I am new. This script is generating a readme for you. But at some point the readme gets updated separately from script? So then the generated data is no longer valid and overrides existing content?

[DukeFerdinand]

@rmenner yep! the README is totally de-coupled from the repository and is retrieved from external sources. This is intended to keep all of our base README files the same across every auro repository (sans any external code that gets injected via the same build script).

TL;DR: remote README template gets pulled, cached in a directory, and filled with template + variable data when you run build:docs

[blackfalcon]

:tada: This PR is included in version 2.10.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: