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

Fix deploy error and deploy test case #2346

Merged
merged 2 commits into from
Jul 30, 2023
Merged

Conversation

WillCWX
Copy link
Contributor

@WillCWX WillCWX commented Jul 24, 2023

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Close #2333
Related to #2331

Overview of changes:

  • Migrate Site/index.js to TypeScript again.
  • Change options.remote to be defaultOptionConfig.remote instead of ''
    • This fixes the deploy error
  • Remove options.remote = defaultDeployConfig.remote in getDepUrl
    • This fixes the false negative for the deploy test case

Anything you'd like to highlight/discuss:

No

Testing instructions:

set up a test repo that with github pages
run markbind deploy

Proposed commit message: (wrap lines at 72 characters)

Fix deploy error and deploy test case

Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt self-requested a review July 26, 2023 12:13
Copy link
Contributor

@tlylt tlylt left a comment

Choose a reason for hiding this comment

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

Thank you @WillCWX for working on this PR. I have a few comments. Main issues:

  • Could you take another look at the original PR and the changes made? https://github.com/MarkBind/markbind/pull/2270/files
    • I'm not sure why some changes (deletion, type assertions) that were made are not transferred back in this PR. I have pointed out a few places but I realized they are not done properly. If you have any concerns or comments as to why those are not necessary changes, please indicate for discussion.
  • After everything is done, will need to re-organize into 2 commits as specified in the DG, one for rename, and one for migration. (Please rebase first as well)

.gitignore Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Show resolved Hide resolved
packages/core/src/Site/index.ts Outdated Show resolved Hide resolved
packages/core/src/Site/index.ts Show resolved Hide resolved
@WillCWX
Copy link
Contributor Author

WillCWX commented Jul 29, 2023

I've compared the current migration with the previous PR and also the v5.0.0 file and made the changes accordingly.
I have followed the previous versions, except for some small comment (deleting extra spaces) / positioning changes.

As requested, I've removed the comments noted and also all the {Type} in @param {Type}.

@WillCWX
Copy link
Contributor Author

WillCWX commented Jul 29, 2023

If its ok, I'll merge with master to update the branch and then rebase into two commits as mentioned in the docs.

@tlylt
Copy link
Contributor

tlylt commented Jul 29, 2023

Oh wait sorry let me do a final check

@tlylt
Copy link
Contributor

tlylt commented Jul 30, 2023

👍 @WillCWX can organize and will merge after that's done

Site/index.ts was previously bugged and caused errors with markbind
deploy. As a stopgap measure, Site/index.ts was re-adapted back to JS.

The bug has now been identified along with a fix, however,
Site/index will need to be remigrated back to TS. The false negative
test case in deploy has also been identifed and will be fixed as well.

Let's remigrate Site/index to TS, fix the deploy option that caused
the markbind deploy bug and also fix the negative test case that failed
to detect the bug.

Migration was made according to the original migration PR and the latest
v5.0.0.
@tlylt tlylt added this to the v5.0.2 milestone Jul 30, 2023
@tlylt tlylt merged commit 77d6410 into MarkBind:master Jul 30, 2023
6 checks passed
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.

markbind deploy error after migrating Site/index.js to TypeScript
2 participants