vstemen's picture

Posted by vstemen on Sat, Dec 08, 2018 - 9:45am

My apologies ahead of time if I'm overlooking the obvious, but I have not found any github or backdrop documentation that clarifies how to do this. I am looking at an issue, #2351. I was involved in the discussion but never tested the pull request because I never did figure out how to do it in the short amount of time I had over the last couple weeks. It shows, BWPanda added "status - has pull request" "pr - needs review" labels. A followup comment said "I gave this a quick spin in the PR sandbox...". So how does one do that? I clicked on the "pr - needs review" link and it takes me to the entire list of issues needing review. So I search for issue #2351 using the filters field and it only finds issue #2402. I went back and clicked on "status - has pull request". That takes me to the entire list of pull requests for all pr's. Again, a search for #2351, only finds issue #2402. OK. Back to the original issue page, https://github.com/backdrop/backdrop-issues/issues/2351 I try clicking the "Pull requests" tab at the top of the page. That only reveals 1 open issue, #3409, which does not appear to be related to this issue at all. I click the "5 closed" link. That does not find this issue either. On the https://backdropcms.org/contribute page, it says

  we could use your help testing our work. Check the GitHub issue
  queue for issues that are tagged with needs review. There is
  a sandbox site created automatically for each PR, and we could use
  some help testing those sites for the intended changes.

But everything I try sends me either in circles or to dead ends. I would think that the "has pull request" or the "pr - needs review" link would take me directly to the sandbox for testing. Or, at least, take me to the repository page with a link to download the code for testing. After going in circles for a while, I finally noticed a link posted on the #2351 pr page to yet another pr, #2388. I clicked on that one, yet still no links anywhere to take me to a sandbox site for testing.  

Accepted answer

This is a good question. In the example you used, you should find the actual pull request in the discussion thread.

If you click on the pull request, it will take you here:

    https://github.com/backdrop/backdrop/pull/2388

On this issue, you will find a link to a sandbox along with login credentials. 

This should work for most core issues, but personally I've been trying to figure out the best way to test contrib pull requests (I have not yet looked very hard). 

Better or easier to find documentation would be helpful.

Summary:

  • Click on the PR link
  • once in the PR link you will see a link to the sandbox site and the credentials for admin for that site
  • Click on the sandbox link and copy and paste the admin creds
  • verify that the issue being discussed is corrected or functioning as expected

Most helpful answers

Hello @vls ...may I add to

Hello @vls ...may I add to @stpaultim's answer by pointing you to a recent comment I made to help another person with finding their way around PRs and PR sandboxes: https://github.com/backdrop/backdrop-issues/issues/3405#issuecomment-444...

I am usually lurking in the GitHub issue queue, and each time someone files a PR, I add a link to it in the issue summary (the first comment in the issue). As more/other PRs are contributed, I keep adding links to them in the issue summary, along with comments to help distinguish which one is the most recent PR. Look in https://github.com/backdrop/backdrop-issues/issues/37 for example, where quite a few PRs have been filed over time:

...I am not the only one doing this (adding the PR links to the issue summaries), but not everyone can do it unfortunately -only GitHub project administrators-, so you might come across certain issues that do not have those links in the issue summary. In such cases, please post a short comment in the GitHub issue, and I am sure that someone will point you to the PR.

I hope this helps :)

Comments

Sat, Dec 08, 2018 - 2:21pm by stpaultim

This is a good question. In the example you used, you should find the actual pull request in the discussion thread.

If you click on the pull request, it will take you here:

    https://github.com/backdrop/backdrop/pull/2388

On this issue, you will find a link to a sandbox along with login credentials. 

This should work for most core issues, but personally I've been trying to figure out the best way to test contrib pull requests (I have not yet looked very hard). 

Better or easier to find documentation would be helpful.

Summary:

  • Click on the PR link
  • once in the PR link you will see a link to the sandbox site and the credentials for admin for that site
  • Click on the sandbox link and copy and paste the admin creds
  • verify that the issue being discussed is corrected or functioning as expected
vstemen's picture

Sat, Dec 08, 2018 - 2:47pm by vstemen

Thanks stpaultim. I had clicked on that link prior posting this question, but missed the Website link in the page to access the sandbox site. I see it now :-).

Yes, we could use better documentation explaining how to find the sandbox sites for testing pull requests.  I guess your instructions here in the forum can server as documentation for it :-).

 

klonos's picture

Sun, Dec 09, 2018 - 5:13am by klonos

Hello @vls ...may I add to @stpaultim's answer by pointing you to a recent comment I made to help another person with finding their way around PRs and PR sandboxes: https://github.com/backdrop/backdrop-issues/issues/3405#issuecomment-444...

I am usually lurking in the GitHub issue queue, and each time someone files a PR, I add a link to it in the issue summary (the first comment in the issue). As more/other PRs are contributed, I keep adding links to them in the issue summary, along with comments to help distinguish which one is the most recent PR. Look in https://github.com/backdrop/backdrop-issues/issues/37 for example, where quite a few PRs have been filed over time:

...I am not the only one doing this (adding the PR links to the issue summaries), but not everyone can do it unfortunately -only GitHub project administrators-, so you might come across certain issues that do not have those links in the issue summary. In such cases, please post a short comment in the GitHub issue, and I am sure that someone will point you to the PR.

I hope this helps :)

vstemen's picture

Sun, Dec 09, 2018 - 6:45am by vstemen

Ah.  Very useful information.  Thanks @klonos.

Sat, Dec 08, 2018 - 3:32pm by stpaultim

Asking and answering questions in the forum is a great way to document things and I often ask questions here, simply because I can't find any documentation. If someone else answers my question, then we automatically have documentation. If they don't, I might come back myself and answer the question in the future. 

But, I think in this case, we ought to document this on BackdropCMS.org and I've created a ticket to do so. 

https://github.com/backdrop-ops/backdropcms.org/issues/485

Anyone can create a Github ticket to make BackdropCMS.org better.