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

Remove special characters from txn readme #86

Merged
merged 1 commit into from
Sep 6, 2024

Conversation

sydneynotthecity
Copy link
Contributor

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with the jira ticket associated with the PR.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated the docs and README with the added features, breaking changes, new instructions on how to use the repository.

Release planning

  • I've decided if this PR requires a new major/minor/patch version accordingly to
    semver, and I've changed the name of the BRANCH to release/* , feature/* or patch/* .

What

Strip special characters out of README descriptions to confirm if the special characters builds the manifest.json incorrectly.

Why

Schema descriptions are not appropriately updated in the test project, the pipeline fails with the following error:

application_order
BigQuery error in update operation: The description for field fee_charged is too
long. The maximum length is 1024 characters.
Error: Process completed with exit code 1.

If you look in Bigquery, the description contains metadata from manifest.json for the fee_charged field:

The fee (in stroops) paid by the source account to apply this transaction to the ledger. At minimum, a transaction is charged # of operations Makefile README.md account_signers_current_schema.txt account_signers_schema.txt accounts_current_schema.txt accounts_schema.txt analyses ci_profiles.sh claimable_balances_schema.txt config_settings_schema.txt contract_code_schema.txt contract_data_schema.txt country_code_schema.txt dbt_packages dbt_project.yml docker enriched_history_operations_schema.txt example.env gha-creds-8860b0d2aff83fdd.json history_assets_schema.txt history_assets_staging_schema.txt history_contract_events_schema.txt history_effects_schema.txt history_ledgers_schema.txt history_operations_schema.txt history_operations_temp_schema.txt history_trades_schema.txt history_transactions_schema.txt jenkins_lint_and_test.sh logs macros models packages.yml pre-commit profiles.yml requirements.txt seeds setup.sh snapshots target tests update_public_schema.sh base fee. The minimum base fee is 100 stroops

I think the * is causing weird things to happen, want to test to see if CI passes.

Known limitations

[TODO or N/A]

@sydneynotthecity sydneynotthecity requested a review from a team as a code owner September 6, 2024 16:01
@chowbao
Copy link
Contributor

chowbao commented Sep 6, 2024

I think the * is causing weird things to happen

That's so unfortunate 😢

@sydneynotthecity sydneynotthecity merged commit 9e39777 into master Sep 6, 2024
3 checks passed
@sydneynotthecity sydneynotthecity deleted the patch/update-txn-docs branch November 14, 2024 14:32
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.

3 participants